Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Web service parameters

This operation allows the cancellation request of a contract issued in EVICERTIA. It should also be taken into account that a contract can be cancelled as long as there is at least one signer left to sign. These are the data required for the cancellation of a contract:

  • Id: Contract identifier that is pretended to cancel. This identifier is the uniqueId that is returned as Response when submitting a contract through the EviSignSubmit method.
  • Comments: Text comment that is aimed to communicate to the signers. It is mandatory to inform the text of the comment that will be sent to each of the signers in a notification, indicating that the contract has been cancelled.
  • Quietly[optional]: It indicates whether the notification about the cancellation of EviSign should be sent (false) or not (true). Its default value is false.

...

Code Block
titleExample of request in JSON
POST https://app.evicertiaecertia.com/api/EviSign/Cancel HTTP/1.1
Content-Type: application/json
Accept: application/json
Authorization: basic XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX==
Host: app.evicertiaecertia.com

{
	"uniqueid":"568a7105-21f8-4be1-b4ea-a7f900c4bf59",
	"comments":"Cancelled for data error"
}


In case of successful cancellation, the EviId of the cancelled contract is returned in the response.


Code Block
titleExample of answer in JSON
{
	"eviId":"568a7105-21f8-4be1-b4ea-a7f900c4bf59"
}

...