POST api/GetWorkflowInfo

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
WorkflowId	integer	None.
ReferenceNo	string	None.
ParentDocumentId	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "WorkflowId": 1,
  "ReferenceNo": "sample string 2",
  "ParentDocumentId": 3
}

application/xml, text/xml

Sample:

<WorkflowInfoInput xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <WorkflowId>1</WorkflowId>
  <ReferenceNo>sample string 2</ReferenceNo>
  <ParentDocumentId>3</ParentDocumentId>
</WorkflowInfoInput>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ReturnObjectOfWorkflowInfo

Name	Type	Additional information
IsSuccess	boolean	None.
Messages	Collection of string	None.
ErrorCode	integer	None.
Response	WorkflowInfo	None.

Response Formats

application/json, text/json

Sample:

{
  "IsSuccess": true,
  "Messages": [
    "sample string 1",
    "sample string 2"
  ],
  "ErrorCode": 2,
  "Response": {
    "WorkflowId": 1,
    "ReferenceNo": "sample string 2",
    "WorkflowStatus": "sample string 3",
    "NoOfDocuments": 4,
    "NoOfAttachment": 5,
    "WorkflowType": "sample string 6",
    "DocumentOwner": "sample string 7",
    "LastModifiedBy": "sample string 8",
    "DeclinedDate": "sample string 9",
    "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
      },
      {
        "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
      }
    ],
    "DocumentInfo": [
      {
        "TemplateId": 1,
        "DocumentName": "sample string 2",
        "DocumentId": 3,
        "UploadDateTime": "sample string 4",
        "DocumentSize": "sample string 5",
        "Modifieddate": "sample string 6",
        "LastModifiedBy": "sample string 7",
        "DeclinedDate": "sample string 8"
      },
      {
        "TemplateId": 1,
        "DocumentName": "sample string 2",
        "DocumentId": 3,
        "UploadDateTime": "sample string 4",
        "DocumentSize": "sample string 5",
        "Modifieddate": "sample string 6",
        "LastModifiedBy": "sample string 7",
        "DeclinedDate": "sample string 8"
      }
    ]
  }
}

application/xml, text/xml

Sample:

<ReturnObjectOfWorkflowInfo 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>
    <WorkflowId>1</WorkflowId>
    <ReferenceNo>sample string 2</ReferenceNo>
    <WorkflowStatus>sample string 3</WorkflowStatus>
    <NoOfDocuments>4</NoOfDocuments>
    <NoOfAttachment>5</NoOfAttachment>
    <WorkflowType>sample string 6</WorkflowType>
    <DocumentOwner>sample string 7</DocumentOwner>
    <LastModifiedBy>sample string 8</LastModifiedBy>
    <DeclinedDate>sample string 9</DeclinedDate>
    <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>
      </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>
      </Signatories>
    </Signatories>
    <DocumentInfo>
      <DocumentInfo>
        <TemplateId>1</TemplateId>
        <DocumentName>sample string 2</DocumentName>
        <DocumentId>3</DocumentId>
        <UploadDateTime>sample string 4</UploadDateTime>
        <DocumentSize>sample string 5</DocumentSize>
        <Modifieddate>sample string 6</Modifieddate>
        <LastModifiedBy>sample string 7</LastModifiedBy>
        <DeclinedDate>sample string 8</DeclinedDate>
      </DocumentInfo>
      <DocumentInfo>
        <TemplateId>1</TemplateId>
        <DocumentName>sample string 2</DocumentName>
        <DocumentId>3</DocumentId>
        <UploadDateTime>sample string 4</UploadDateTime>
        <DocumentSize>sample string 5</DocumentSize>
        <Modifieddate>sample string 6</Modifieddate>
        <LastModifiedBy>sample string 7</LastModifiedBy>
        <DeclinedDate>sample string 8</DeclinedDate>
      </DocumentInfo>
    </DocumentInfo>
  </Response>
</ReturnObjectOfWorkflowInfo>