POST api/CancelSignatureRequest
Request Information
URI Parameters
None.
Body Parameters
CancelSignatureRequestObject| Name | Description | Type | Additional information |
|---|---|---|---|
| ExtRefID | string |
None. |
|
| DocumentName | string |
None. |
|
| DocumentVersion | string |
None. |
|
| CancellingUserID | integer |
None. |
|
| CancellingUserName | string |
None. |
Request Formats
application/json, text/json
Sample:
{
"ExtRefID": "sample string 1",
"DocumentName": "sample string 2",
"DocumentVersion": "sample string 3",
"CancellingUserID": 4,
"CancellingUserName": "sample string 5"
}
application/xml, text/xml
Sample:
<CancelSignatureRequestObject xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SignEasy.SignatureRequest"> <CancellingUserID>4</CancellingUserID> <CancellingUserName>sample string 5</CancellingUserName> <DocumentName>sample string 2</DocumentName> <DocumentVersion>sample string 3</DocumentVersion> <ExtRefID>sample string 1</ExtRefID> </CancelSignatureRequestObject>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
SignatureRequestResponseObject| Name | Description | Type | Additional information |
|---|---|---|---|
| ResponseCode | integer |
None. |
|
| ResponseOutput | string |
None. |
|
| SignLocationRedirect | string |
None. |
|
| ErrorDescription | string |
None. |
Response Formats
application/json, text/json
Sample:
{
"ResponseCode": 1,
"ResponseOutput": "sample string 2",
"SignLocationRedirect": "sample string 3",
"ErrorDescription": "sample string 4"
}
application/xml, text/xml
Sample:
<SignatureRequestResponseObject xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SignEasy.SignatureRequest"> <ErrorDescription>sample string 4</ErrorDescription> <ResponseCode>1</ResponseCode> <ResponseOutput>sample string 2</ResponseOutput> <SignLocationRedirect>sample string 3</SignLocationRedirect> </SignatureRequestResponseObject>