Skip to main content

Signature

A signature is a way of signing documents (cf. Electronic signature).

Signature methods​

Information for the initialization of the electronic signature​

Returns the details needed for the creation of the signature process.

Method​

GET/api/externals/v1/signature/{objectTypeID}/{entityTypeID}/{entityID}/creationDetails

Arguments​

  • objectTypeID (long) (provided in the path): Type of the signature (3 = Document)
  • entityTypeID (long) (provided in the path): ID of the object type (DocumentTypeID if objectTypeID = 3)
  • entityID (long) (provided in the path): ID of the entity type (DocumentID if objectTypeID = 3)
  • winLangID (long) : Windows Language Identifier of the resulting data
Body​

(none)

Response​

{
  "signatureDetails": [
      { 
        "id": long,
        "email": string,
        "firstName": string,
        "lastName": string, // Last name or company name 
        "companyName": string, // First name or company title
        "phone": string,
        "content": string, // PDF
        "name": string,
        "sellerEmail": string,
        "documentName": string,
      }
    ],
    "winLangID": long,
    "success": boolean,
    "message": string,
    "rowCount": long
}

Pending List​

Returns the List of all Signatures in pending status.

Method​

GET/api/externals/v1/signature/pendingList/

Arguments​

  • winLangID (long) : Windows Language Identifier of the resulting data
  • storeID (long) : ID of the Store owning the searched signature
Body​

(none)

Response​

{
  "winLangID": long,
  "success": bool,
  "message": string,
  "rowCount": long,
  "signatures": [
    {
      "companyID": long,
      "objectTypeID": long,
      "entityTypeID": long,
      "entityID": long,
      "processID": string,
      "processCreatedOn": datetime
    }
  ]
}

Create Project comment​

Creates a comment in the project with the signature status.

Method​

POST/api/externals/v1/signature/{objectTypeID}/{entityTypeID}/{entityID}/{processID}/projectComment

Arguments​

  • objectTypeID (long) (provided in the path): Type of the signature (3 = Document)
  • entityTypeID (long) (provided in the path): ID of the object type (DocumentTypeID if objectTypeID = 3)
  • entityID (long) (provided in the path): ID of the entity type (DocumentID if objectTypeID = 3)
  • processID (long) (provided in the path): ID of the process
  • kindMessage (long) : Kind of the message (0 = SEND / 1 = CANCEL / 2 = SIGNED)
  • winLangID (long) : Windows Language Identifier of the resulting data
Body​
{
  “Custom Message to Write in the comment”
}

Response​

{
  "success": boolean,
  "message": string,
  "rowCount": long
}

Create Document status​

Saves the document status and links the process to document.

Method​

POST/api/externals/v1/signature/{objectTypeID}/{entityTypeID}/{entityID}/{processID}

Arguments​

  • objectTypeID (long) (provided in the path): Type of the signature (3 = Document)
  • entityTypeID (long) (provided in the path): ID of the object type (DocumentTypeID if objectTypeID = 3)
  • entityID (long) (provided in the path): ID of the entity type (DocumentID if objectTypeID = 3)
  • processID (long) (provided in the path): ID of the process
  • provider (string) : Name of provider used (30 char)
  • winLangID (long) : Windows Language Identifier of the resulting data
Body​

(none)

Response​

{
  "success": boolean,
  "message": string,
  "rowCount": long
}

Sign a document​

Signs the document and links the signed document to the object.

Method​

PUT/api/externals/v1/signature/{objectTypeID}/{entityTypeID}/{entityID}/{processID}/signed

Arguments​

  • objectTypeID (long) (provided in the path): Type of the signature (3 = Document)
  • entityTypeID (long) (provided in the path): ID of the object type (DocumentTypeID if objectTypeID = 3)
  • entityID (long) (provided in the path): ID of the entity type (DocumentID if objectTypeID = 3)
  • processID (long) (provided in the path): ID of the process
  • winLangID (long) : Windows Language Identifier of the resulting data
Body​
{
  File to save (binary raw) Byte []
}

Response​

{
  "success": boolean,
  "message": string,
  "rowCount": long
}

Delete process​

Deletes the specified process and refreshes the document status.

Method​

DELETE/api/externals/v1/signature/{objectTypeID}/{entityTypeID}/{entityID}/{processID}

Arguments​

  • objectTypeID (long) (provided in the path): Type of the signature (3 = Document)
  • entityTypeID (long) (provided in the path): ID of the object type (DocumentTypeID if objectTypeID = 3)
  • entityID (long) (provided in the path): ID of the entity type (DocumentID if objectTypeID = 3)
  • processID (long) (provided in the path): ID of the process
  • winLangID (long) : Windows Language Identifier of the resulting data
Body​

(none)

Response​

{
  "success": boolean,
  "message": string,
  "rowCount": long
}