POST api/DownloadWorkflowDocuments

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
WorkFlowId	integer	None.
DocumentId	integer	None.
ReferenceNo	string	None.
IsMerged	boolean	None.

Request Formats

application/json, text/json

Sample:

{
  "WorkFlowId": 1,
  "DocumentId": 2,
  "ReferenceNo": "sample string 3",
  "IsMerged": true
}

application/xml, text/xml

Sample:

<DocumentDownloadInput xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <WorkFlowId>1</WorkFlowId>
  <DocumentId>2</DocumentId>
  <ReferenceNo>sample string 3</ReferenceNo>
  <IsMerged>true</IsMerged>
</DocumentDownloadInput>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ReturnObjectOfFileDownloadResponse

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

Response Formats

application/json, text/json

Sample:

{
  "IsSuccess": true,
  "Messages": [
    "sample string 1",
    "sample string 2"
  ],
  "ErrorCode": 2,
  "Response": {
    "ReferenceNo": "sample string 1",
    "WorkflowId": 2,
    "FileList": [
      {
        "DocumentName": "sample string 1",
        "Base64FileData": "sample string 2",
        "DocumentId": 3,
        "IsAttachment": true
      },
      {
        "DocumentName": "sample string 1",
        "Base64FileData": "sample string 2",
        "DocumentId": 3,
        "IsAttachment": true
      }
    ]
  }
}

application/xml, text/xml

Sample:

<ReturnObjectOfFileDownloadResponse 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>
    <ReferenceNo>sample string 1</ReferenceNo>
    <WorkflowId>2</WorkflowId>
    <FileList>
      <Files>
        <DocumentName>sample string 1</DocumentName>
        <Base64FileData>sample string 2</Base64FileData>
        <DocumentId>3</DocumentId>
        <IsAttachment>true</IsAttachment>
      </Files>
      <Files>
        <DocumentName>sample string 1</DocumentName>
        <Base64FileData>sample string 2</Base64FileData>
        <DocumentId>3</DocumentId>
        <IsAttachment>true</IsAttachment>
      </Files>
    </FileList>
  </Response>
</ReturnObjectOfFileDownloadResponse>