POST api/Document/DigitalSignatureAddDocumentToTransaction

Adds a document to a digital signature transaction

Request Information

URI Parameters

None.

Body Parameters

Input parameter

WorkPoint365.WebAPI.Model.Document+DigitalSignatureAddDocumentToTransactionParameter

Name	Description	Type	Additional information
TransactionID	The transacation id	string	None.
DocumentSiteUrl	The absolute site url of where the document is saved	string	None.
DocumentUrl	The absolute document url	string	None.
SigningSetPropertiesBehaviour	The signing properties behaviour	WorkPoint365.WebAPI.Model.Document+SigningSetPropertiesBehaviour	None.
SigningDeclareAsRecordBehaviour	The record declaration setting	WorkPoint365.WebAPI.Model.Document+SigningDeclareAsRecordBehaviour	None.
SigningType	The signing type	WorkPoint365.WebAPI.Model.Document+SigningType	None.
PdfFormat	The PDF format to be used. If not specified the default PDF format will be used	WorkPoint365.WebAPI.Model.Document+PdfFormat	None.

Request Formats

application/json, text/json

Sample:

{
  "TransactionID": "sample string 1",
  "DocumentSiteUrl": "sample string 2",
  "DocumentUrl": "sample string 3",
  "SigningSetPropertiesBehaviour": 10,
  "SigningDeclareAsRecordBehaviour": 1,
  "SigningType": 10,
  "PdfFormat": 0
}

application/xml, text/xml

Sample:

<Document.DigitalSignatureAddDocumentToTransactionParameter xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WorkPoint365.WebAPI.Model">
  <DocumentSiteUrl>sample string 2</DocumentSiteUrl>
  <DocumentUrl>sample string 3</DocumentUrl>
  <PdfFormat>PDF_A_1A</PdfFormat>
  <SigningDeclareAsRecordBehaviour>DoNotDeclare</SigningDeclareAsRecordBehaviour>
  <SigningSetPropertiesBehaviour>IgnoreErrors</SigningSetPropertiesBehaviour>
  <SigningType>StandardSigning</SigningType>
  <TransactionID>sample string 1</TransactionID>
</Document.DigitalSignatureAddDocumentToTransactionParameter>

Response Information

Resource Description

WorkPoint365.WebAPI.Model.Document+DigitalSignatureAddDocumentToTransactionReturnValue

Name	Description	Type	Additional information
PdfUrl	Pdf url	string	None.
PdfServerRelativeUrl	Pdf server releative url	string	None.
Errors	A collection of errors	Collection of WorkPoint365.WebAPI.Model.Document+DigitalSignatureError	None.

Response Formats

application/json, text/json

Sample:

Sample not available.