GET api/GetWorkflowInfo?WorkFlowId={WorkFlowId}&ReferenceNo={ReferenceNo}&ParentDocumentId={ParentDocumentId}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| WorkFlowId | string |
Default value is |
|
| ReferenceNo | string |
Default value is |
|
| ParentDocumentId | integer |
Default value is 0 |
Body Parameters
None.
Response Information
Resource Description
ReturnObjectOfListOfDocumentInfo| Name | Description | Type | Additional information |
|---|---|---|---|
| IsSuccess | boolean |
None. |
|
| Messages | Collection of string |
None. |
|
| ErrorCode | integer |
None. |
|
| Response | Collection of DocumentInfo |
None. |
Response Formats
application/json, text/json
Sample:
{
"IsSuccess": true,
"Messages": [
"sample string 1",
"sample string 2"
],
"ErrorCode": 2,
"Response": [
{
"Signatories": [
{
"EmailID": "sample string 1",
"Name": "sample string 2",
"Status": "sample string 3",
"Remarks": "sample string 4",
"SignerType": 5,
"SignedDate": "sample string 6",
"ModeOfSignature": "sample string 7",
"WorkId": 8,
"CurrentSignatoryName": "sample string 9",
"PercentageNameMatch": "sample string 10"
},
{
"EmailID": "sample string 1",
"Name": "sample string 2",
"Status": "sample string 3",
"Remarks": "sample string 4",
"SignerType": 5,
"SignedDate": "sample string 6",
"ModeOfSignature": "sample string 7",
"WorkId": 8,
"CurrentSignatoryName": "sample string 9",
"PercentageNameMatch": "sample string 10"
}
],
"DocumentName": "sample string 1",
"WorkflowName": "sample string 2",
"DocumentNumber": "sample string 3",
"DocumentId": 4,
"UploadDateTime": "sample string 5",
"DocumentSize": "sample string 6",
"NoOfAttachment": 7,
"NoOfDocuments": 8,
"SubscriberId": 9,
"Modifieddate": "sample string 10",
"DocumentOwner": "sample string 11",
"ReferenceNo": "sample string 12",
"CurrentSigner": 13,
"StatusId": 14,
"WorkflowType": "sample string 15",
"LastModifiedBy": "sample string 16",
"CurrentSignatoryName": "sample string 17",
"PercentageNameMatch": "sample string 18"
},
{
"Signatories": [
{
"EmailID": "sample string 1",
"Name": "sample string 2",
"Status": "sample string 3",
"Remarks": "sample string 4",
"SignerType": 5,
"SignedDate": "sample string 6",
"ModeOfSignature": "sample string 7",
"WorkId": 8,
"CurrentSignatoryName": "sample string 9",
"PercentageNameMatch": "sample string 10"
},
{
"EmailID": "sample string 1",
"Name": "sample string 2",
"Status": "sample string 3",
"Remarks": "sample string 4",
"SignerType": 5,
"SignedDate": "sample string 6",
"ModeOfSignature": "sample string 7",
"WorkId": 8,
"CurrentSignatoryName": "sample string 9",
"PercentageNameMatch": "sample string 10"
}
],
"DocumentName": "sample string 1",
"WorkflowName": "sample string 2",
"DocumentNumber": "sample string 3",
"DocumentId": 4,
"UploadDateTime": "sample string 5",
"DocumentSize": "sample string 6",
"NoOfAttachment": 7,
"NoOfDocuments": 8,
"SubscriberId": 9,
"Modifieddate": "sample string 10",
"DocumentOwner": "sample string 11",
"ReferenceNo": "sample string 12",
"CurrentSigner": 13,
"StatusId": 14,
"WorkflowType": "sample string 15",
"LastModifiedBy": "sample string 16",
"CurrentSignatoryName": "sample string 17",
"PercentageNameMatch": "sample string 18"
}
]
}
application/xml, text/xml
Sample:
<ReturnObjectOfListOfDocumentInfo xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<IsSuccess>true</IsSuccess>
<Messages>
<string>sample string 1</string>
<string>sample string 2</string>
</Messages>
<ErrorCode>2</ErrorCode>
<Response>
<DocumentInfo>
<Signatories>
<Signatories>
<EmailID>sample string 1</EmailID>
<Name>sample string 2</Name>
<Status>sample string 3</Status>
<Remarks>sample string 4</Remarks>
<SignerType>5</SignerType>
<SignedDate>sample string 6</SignedDate>
<ModeOfSignature>sample string 7</ModeOfSignature>
<WorkId>8</WorkId>
<CurrentSignatoryName>sample string 9</CurrentSignatoryName>
<PercentageNameMatch>sample string 10</PercentageNameMatch>
</Signatories>
<Signatories>
<EmailID>sample string 1</EmailID>
<Name>sample string 2</Name>
<Status>sample string 3</Status>
<Remarks>sample string 4</Remarks>
<SignerType>5</SignerType>
<SignedDate>sample string 6</SignedDate>
<ModeOfSignature>sample string 7</ModeOfSignature>
<WorkId>8</WorkId>
<CurrentSignatoryName>sample string 9</CurrentSignatoryName>
<PercentageNameMatch>sample string 10</PercentageNameMatch>
</Signatories>
</Signatories>
<DocumentName>sample string 1</DocumentName>
<WorkflowName>sample string 2</WorkflowName>
<DocumentNumber>sample string 3</DocumentNumber>
<DocumentId>4</DocumentId>
<UploadDateTime>sample string 5</UploadDateTime>
<DocumentSize>sample string 6</DocumentSize>
<NoOfAttachment>7</NoOfAttachment>
<NoOfDocuments>8</NoOfDocuments>
<SubscriberId>9</SubscriberId>
<Modifieddate>sample string 10</Modifieddate>
<DocumentOwner>sample string 11</DocumentOwner>
<ReferenceNo>sample string 12</ReferenceNo>
<CurrentSigner>13</CurrentSigner>
<StatusId>14</StatusId>
<WorkflowType>sample string 15</WorkflowType>
<LastModifiedBy>sample string 16</LastModifiedBy>
<CurrentSignatoryName>sample string 17</CurrentSignatoryName>
<PercentageNameMatch>sample string 18</PercentageNameMatch>
</DocumentInfo>
<DocumentInfo>
<Signatories>
<Signatories>
<EmailID>sample string 1</EmailID>
<Name>sample string 2</Name>
<Status>sample string 3</Status>
<Remarks>sample string 4</Remarks>
<SignerType>5</SignerType>
<SignedDate>sample string 6</SignedDate>
<ModeOfSignature>sample string 7</ModeOfSignature>
<WorkId>8</WorkId>
<CurrentSignatoryName>sample string 9</CurrentSignatoryName>
<PercentageNameMatch>sample string 10</PercentageNameMatch>
</Signatories>
<Signatories>
<EmailID>sample string 1</EmailID>
<Name>sample string 2</Name>
<Status>sample string 3</Status>
<Remarks>sample string 4</Remarks>
<SignerType>5</SignerType>
<SignedDate>sample string 6</SignedDate>
<ModeOfSignature>sample string 7</ModeOfSignature>
<WorkId>8</WorkId>
<CurrentSignatoryName>sample string 9</CurrentSignatoryName>
<PercentageNameMatch>sample string 10</PercentageNameMatch>
</Signatories>
</Signatories>
<DocumentName>sample string 1</DocumentName>
<WorkflowName>sample string 2</WorkflowName>
<DocumentNumber>sample string 3</DocumentNumber>
<DocumentId>4</DocumentId>
<UploadDateTime>sample string 5</UploadDateTime>
<DocumentSize>sample string 6</DocumentSize>
<NoOfAttachment>7</NoOfAttachment>
<NoOfDocuments>8</NoOfDocuments>
<SubscriberId>9</SubscriberId>
<Modifieddate>sample string 10</Modifieddate>
<DocumentOwner>sample string 11</DocumentOwner>
<ReferenceNo>sample string 12</ReferenceNo>
<CurrentSigner>13</CurrentSigner>
<StatusId>14</StatusId>
<WorkflowType>sample string 15</WorkflowType>
<LastModifiedBy>sample string 16</LastModifiedBy>
<CurrentSignatoryName>sample string 17</CurrentSignatoryName>
<PercentageNameMatch>sample string 18</PercentageNameMatch>
</DocumentInfo>
</Response>
</ReturnObjectOfListOfDocumentInfo>