POST api/digitalsignature/signable/cancelled/{fingerprint}

creates an event when a document is cancelled

Request Information

URI Parameters

NameDescriptionTypeAdditional information
fingerprint

string

Required

Body Parameters

SignableReziMetaDataDataContract
NameDescriptionTypeAdditional information
documentSubTypeSystemName

string

None.

subject

string

None.

agencyId

integer

None.

branchId

integer

None.

brandId

integer

None.

negotiatorId

integer

None.

ownsRoleId

integer

None.

groupRoleIds

Collection of integer

None.

propertyRoleIds

Collection of integer

None.

documentLevelMetaData

Dictionary of string [key] and PostDocGenerationHandlerDataContract [value]

None.

Request Formats

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'SignableReziMetaDataDataContract'.

application/json, text/json

Sample:
{
  "documentSubTypeSystemName": "sample string 1",
  "subject": "sample string 2",
  "agencyId": 3,
  "branchId": 4,
  "brandId": 5,
  "negotiatorId": 6,
  "ownsRoleId": 7,
  "groupRoleIds": [
    1,
    2
  ],
  "propertyRoleIds": [
    1,
    2
  ],
  "documentLevelMetaData": {
    "sample string 1": {
      "EntityType": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "EntityId": 1,
      "JobHandlerType": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "Options": {
        "sample string 1": "sample string 2",
        "sample string 3": "sample string 4"
      },
      "DocumentSubType": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "AccountingSystemId": 2,
      "AgencyId": 3
    },
    "sample string 2": {
      "EntityType": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "EntityId": 1,
      "JobHandlerType": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "Options": {
        "sample string 1": "sample string 2",
        "sample string 3": "sample string 4"
      },
      "DocumentSubType": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "AccountingSystemId": 2,
      "AgencyId": 3
    }
  }
}

Response Information

Resource Description

HttpResponseMessage
NameDescriptionTypeAdditional information
Version

Version

None.

Content

HttpContent

None.

StatusCode

HttpStatusCode

None.

ReasonPhrase

string

None.

Headers

Collection of Object

None.

RequestMessage

HttpRequestMessage

None.

IsSuccessStatusCode

boolean

None.