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

creates an event when a document is completed

Request Information

URI Parameters

NameDescriptionTypeAdditional information
fingerprint

string

Required

Body Parameters

Dezrez.Core.DataContracts.External.Providers.DigitalSignature.SignableCompleteReziMetaDataDataContract
NameDescriptionTypeAdditional information
envelope_documents

string

None.

envelope_download

string

None.

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 Dezrez.Core.DataContracts.External.Api.DocumentGeneration.Query.PostDocGenerationHandlerDataContract [value]

None.

Request Formats

application/x-www-form-urlencoded

Sample:

Sample not available.

application/json, text/json

Sample:
{
  "envelope_documents": "sample string 1",
  "envelope_download": "sample string 2",
  "documentSubTypeSystemName": "sample string 3",
  "subject": "sample string 4",
  "agencyId": 5,
  "branchId": 6,
  "brandId": 7,
  "negotiatorId": 8,
  "ownsRoleId": 9,
  "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

Dezrez.Core.DataContracts.External.Api.Job.Query.Get.JobInvocationDetailsDataContract
NameDescriptionTypeAdditional information
SupportsCancellation

boolean

None.

ReportsProgress

boolean

None.

InitialStatusText

string

None.

JobReference

globally unique identifier

None.

Success

boolean

None.

Response Formats

application/json, text/json

Sample:
{
  "SupportsCancellation": true,
  "ReportsProgress": true,
  "InitialStatusText": "sample string 3",
  "JobReference": "fc56a716-8357-4687-bc3e-de2a5b6dfc6d",
  "Success": true
}