You are here

You are here

Canceling an Electronic Signature

The DocumentSendForSignatureCancel method can be used to cancel an electronic signature request.  The only parameter that is specified is the document object for which the signature request should be canceled.

An exception will be thrown if the document is not currently out for signature, so it is recommended to first check the signature status and only make the cancel method call for documents that are currently in status of Waiting.

Vertical Tabs

c#
string documentOutForSignatureId = "<Document Id retrieved by other method calls>";
SCMDocument documentOutForSignature = springCMService.DocumentGetById(token, documentOutForSignatureId, false);
 
SCMQueueStatus signatureStatus = springCMService.DocumentSendForSignatureStatus(token, documentOutForSignature);
 
if (signatureStatus == SCMQueueStatus.Waiting)
{
	springCMService.DocumentSendForSignatureCancel(token, documentOutForSignature);
}
else
{
	Console.WriteLine("Document is not currently out for signature.");
}
java
String documentOutForSignatureId = "<Document Id retrieved by other method calls>";
SCMDocument documentOutForSignature = springCMService.documentGetById(token, documentOutForSignatureId, false);
 
SCMQueueStatus signatureStatus = springCMService.documentSendForSignatureStatus(token, documentOutForSignature);
if(signatureStatus.equals(SCMQueueStatus.Waiting))
{
	springCMService.documentSendForSignatureCancel(token,documentOutForSignature);
}
else
{
	System.out.println("Document is not currently out for signature.");
}