GET api/ESignAgreement?ClientId={ClientId}

Request Information

URI Parameters

Name	Description	Type	Additional information
ClientId		string	Required

Body Parameters

None.

Response Information

Resource Description

DocumentStatus

Name	Type	Additional information
status	integer	None.
docMessage	string	None.
DocumentId	string	None.
TemplateId	string	None.
messages	Collection of Message	None.
data	DatarespDto	None.

Response Formats

application/json, text/json

Sample:

{
  "status": 1,
  "docMessage": "sample string 2",
  "DocumentId": "sample string 3",
  "TemplateId": "sample string 4",
  "messages": [
    {
      "code": "sample string 1",
      "message": "sample string 2"
    },
    {
      "code": "sample string 1",
      "message": "sample string 2"
    }
  ],
  "data": {
    "documentId": "sample string 1",
    "requests": [
      {
        "active": true,
        "email": "sample string 2",
        "expired": true,
        "expiryDate": "sample string 4",
        "name": "sample string 5",
        "phone": "sample string 6",
        "signType": "sample string 7",
        "signUrl": "sample string 8",
        "signed": true
      },
      {
        "active": true,
        "email": "sample string 2",
        "expired": true,
        "expiryDate": "sample string 4",
        "name": "sample string 5",
        "phone": "sample string 6",
        "signType": "sample string 7",
        "signUrl": "sample string 8",
        "signed": true
      }
    ],
    "files": [
      "sample string 1",
      "sample string 2"
    ],
    "auditTrail": "sample string 2"
  }
}

application/xml, text/xml

Sample:

<DocumentStatus xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BusinessObjects">
  <DocumentId>sample string 3</DocumentId>
  <TemplateId>sample string 4</TemplateId>
  <data>
    <auditTrail>sample string 2</auditTrail>
    <documentId>sample string 1</documentId>
    <files xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </files>
    <requests>
      <RequestRespDto>
        <active>true</active>
        <email>sample string 2</email>
        <expired>true</expired>
        <expiryDate>sample string 4</expiryDate>
        <name>sample string 5</name>
        <phone>sample string 6</phone>
        <signType>sample string 7</signType>
        <signUrl>sample string 8</signUrl>
        <signed>true</signed>
      </RequestRespDto>
      <RequestRespDto>
        <active>true</active>
        <email>sample string 2</email>
        <expired>true</expired>
        <expiryDate>sample string 4</expiryDate>
        <name>sample string 5</name>
        <phone>sample string 6</phone>
        <signType>sample string 7</signType>
        <signUrl>sample string 8</signUrl>
        <signed>true</signed>
      </RequestRespDto>
    </requests>
  </data>
  <docMessage>sample string 2</docMessage>
  <messages>
    <Message>
      <code>sample string 1</code>
      <message>sample string 2</message>
    </Message>
    <Message>
      <code>sample string 1</code>
      <message>sample string 2</message>
    </Message>
  </messages>
  <status>1</status>
</DocumentStatus>