POST api/GetDocumentsByStatus
Request Information
URI Parameters
None.
Body Parameters
WorkflowSearchDTO| Name | Description | Type | Additional information |
|---|---|---|---|
| TabStatusType | string |
None. |
|
| Status | string |
None. |
|
| pagenumber | integer |
None. |
|
| PageSize | integer |
None. |
|
| SelectedYear | string |
None. |
|
| DocName | string |
None. |
|
| DocOwner | string |
None. |
|
| StartDate | string |
None. |
|
| EndDate | string |
None. |
|
| LastSignedBy | string |
None. |
|
| CompletedDate | string |
None. |
|
| CompletedEndDate | string |
None. |
|
| DeclinedBy | string |
None. |
|
| DeclinedDate | string |
None. |
|
| DeclineEnddDate | string |
None. |
|
| RecalledDate | string |
None. |
|
| RecalledEndDate | string |
None. |
|
| InactiveDate | string |
None. |
|
| InactiveEndDate | string |
None. |
|
| ExpiryFromDate | string |
None. |
|
| ExpiryToDate | string |
None. |
|
| PurgedDate | string |
None. |
|
| VoidedDate | string |
None. |
|
| TemplateName | string |
None. |
|
| SendImageUrl | boolean |
None. |
|
| CategoryName | string |
None. |
|
| DocumentNumber | string |
None. |
|
| Referenceno | string |
None. |
|
| SignedDate | string |
None. |
|
| Customstatus | string |
None. |
|
| IsSearch | boolean |
None. |
|
| DonotRequireFlexiform | boolean |
None. |
Request Formats
application/json, text/json
Sample:
{
"TabStatusType": "sample string 1",
"Status": "sample string 2",
"pagenumber": 3,
"PageSize": 4,
"SelectedYear": "sample string 5",
"DocName": "sample string 6",
"DocOwner": "sample string 7",
"StartDate": "sample string 8",
"EndDate": "sample string 9",
"LastSignedBy": "sample string 10",
"CompletedDate": "sample string 11",
"CompletedEndDate": "sample string 12",
"DeclinedBy": "sample string 13",
"DeclinedDate": "sample string 14",
"DeclineEnddDate": "sample string 15",
"RecalledDate": "sample string 16",
"RecalledEndDate": "sample string 17",
"InactiveDate": "sample string 18",
"InactiveEndDate": "sample string 19",
"ExpiryFromDate": "sample string 20",
"ExpiryToDate": "sample string 21",
"PurgedDate": "sample string 22",
"VoidedDate": "sample string 23",
"TemplateName": "sample string 24",
"SendImageUrl": true,
"CategoryName": "sample string 26",
"DocumentNumber": "sample string 27",
"Referenceno": "sample string 28",
"SignedDate": "sample string 29",
"Customstatus": "sample string 30",
"IsSearch": true,
"DonotRequireFlexiform": true
}
application/xml, text/xml
Sample:
<WorkflowSearchDTO xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <TabStatusType>sample string 1</TabStatusType> <Status>sample string 2</Status> <pagenumber>3</pagenumber> <PageSize>4</PageSize> <SelectedYear>sample string 5</SelectedYear> <DocName>sample string 6</DocName> <DocOwner>sample string 7</DocOwner> <StartDate>sample string 8</StartDate> <EndDate>sample string 9</EndDate> <LastSignedBy>sample string 10</LastSignedBy> <CompletedDate>sample string 11</CompletedDate> <CompletedEndDate>sample string 12</CompletedEndDate> <DeclinedBy>sample string 13</DeclinedBy> <DeclinedDate>sample string 14</DeclinedDate> <DeclineEnddDate>sample string 15</DeclineEnddDate> <RecalledDate>sample string 16</RecalledDate> <RecalledEndDate>sample string 17</RecalledEndDate> <InactiveDate>sample string 18</InactiveDate> <InactiveEndDate>sample string 19</InactiveEndDate> <ExpiryFromDate>sample string 20</ExpiryFromDate> <ExpiryToDate>sample string 21</ExpiryToDate> <PurgedDate>sample string 22</PurgedDate> <VoidedDate>sample string 23</VoidedDate> <TemplateName>sample string 24</TemplateName> <SendImageUrl>true</SendImageUrl> <CategoryName>sample string 26</CategoryName> <DocumentNumber>sample string 27</DocumentNumber> <Referenceno>sample string 28</Referenceno> <SignedDate>sample string 29</SignedDate> <Customstatus>sample string 30</Customstatus> <IsSearch>true</IsSearch> <DonotRequireFlexiform>true</DonotRequireFlexiform> </WorkflowSearchDTO>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
ReturnObjectOfListOfDashBoardViewModel| Name | Description | Type | Additional information |
|---|---|---|---|
| IsSuccess | boolean |
None. |
|
| Messages | Collection of string |
None. |
|
| ErrorCode | integer |
None. |
|
| Response | Collection of DashBoardViewModel |
None. |
Response Formats
application/json, text/json
Sample:
{
"IsSuccess": true,
"Messages": [
"sample string 1",
"sample string 2"
],
"ErrorCode": 2,
"Response": [
{
"WorkFlowId": 1,
"InitaitedBy": "sample string 2",
"UploadTime": "sample string 3",
"DisplayName": "sample string 4",
"DocumentId": 5,
"LastSignedOn": "sample string 6",
"LastSignedBy": "sample string 7",
"DeclinedOn": "sample string 8",
"DeclinedBy": "sample string 9",
"Remarks": "sample string 10",
"RecalledOn": "sample string 11",
"VoidedOn": "sample string 12",
"PurgedOn": "sample string 13",
"InactivedOn": "sample string 14",
"Status": "sample string 15",
"ThumbnailBase64": "sample string 16",
"ReferenceNo": "sample string 17",
"EnvelopNo": "sample string 18",
"Category": "sample string 19",
"Noofdocuments": 20,
"NoofAttachments": 21,
"Documents": "sample string 22",
"NoOfComments": 23,
"OriginatorId": 24,
"TemplateId": 25,
"WorkflowType": 26
},
{
"WorkFlowId": 1,
"InitaitedBy": "sample string 2",
"UploadTime": "sample string 3",
"DisplayName": "sample string 4",
"DocumentId": 5,
"LastSignedOn": "sample string 6",
"LastSignedBy": "sample string 7",
"DeclinedOn": "sample string 8",
"DeclinedBy": "sample string 9",
"Remarks": "sample string 10",
"RecalledOn": "sample string 11",
"VoidedOn": "sample string 12",
"PurgedOn": "sample string 13",
"InactivedOn": "sample string 14",
"Status": "sample string 15",
"ThumbnailBase64": "sample string 16",
"ReferenceNo": "sample string 17",
"EnvelopNo": "sample string 18",
"Category": "sample string 19",
"Noofdocuments": 20,
"NoofAttachments": 21,
"Documents": "sample string 22",
"NoOfComments": 23,
"OriginatorId": 24,
"TemplateId": 25,
"WorkflowType": 26
}
]
}
application/xml, text/xml
Sample:
<ReturnObjectOfListOfDashBoardViewModel 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>
<DashBoardViewModel>
<WorkFlowId>1</WorkFlowId>
<InitaitedBy>sample string 2</InitaitedBy>
<UploadTime>sample string 3</UploadTime>
<DisplayName>sample string 4</DisplayName>
<DocumentId>5</DocumentId>
<LastSignedOn>sample string 6</LastSignedOn>
<LastSignedBy>sample string 7</LastSignedBy>
<DeclinedOn>sample string 8</DeclinedOn>
<DeclinedBy>sample string 9</DeclinedBy>
<Remarks>sample string 10</Remarks>
<RecalledOn>sample string 11</RecalledOn>
<VoidedOn>sample string 12</VoidedOn>
<PurgedOn>sample string 13</PurgedOn>
<InactivedOn>sample string 14</InactivedOn>
<Status>sample string 15</Status>
<ThumbnailBase64>sample string 16</ThumbnailBase64>
<ReferenceNo>sample string 17</ReferenceNo>
<EnvelopNo>sample string 18</EnvelopNo>
<Category>sample string 19</Category>
<Noofdocuments>20</Noofdocuments>
<NoofAttachments>21</NoofAttachments>
<Documents>sample string 22</Documents>
<NoOfComments>23</NoOfComments>
<OriginatorId>24</OriginatorId>
<TemplateId>25</TemplateId>
<WorkflowType>26</WorkflowType>
</DashBoardViewModel>
<DashBoardViewModel>
<WorkFlowId>1</WorkFlowId>
<InitaitedBy>sample string 2</InitaitedBy>
<UploadTime>sample string 3</UploadTime>
<DisplayName>sample string 4</DisplayName>
<DocumentId>5</DocumentId>
<LastSignedOn>sample string 6</LastSignedOn>
<LastSignedBy>sample string 7</LastSignedBy>
<DeclinedOn>sample string 8</DeclinedOn>
<DeclinedBy>sample string 9</DeclinedBy>
<Remarks>sample string 10</Remarks>
<RecalledOn>sample string 11</RecalledOn>
<VoidedOn>sample string 12</VoidedOn>
<PurgedOn>sample string 13</PurgedOn>
<InactivedOn>sample string 14</InactivedOn>
<Status>sample string 15</Status>
<ThumbnailBase64>sample string 16</ThumbnailBase64>
<ReferenceNo>sample string 17</ReferenceNo>
<EnvelopNo>sample string 18</EnvelopNo>
<Category>sample string 19</Category>
<Noofdocuments>20</Noofdocuments>
<NoofAttachments>21</NoofAttachments>
<Documents>sample string 22</Documents>
<NoOfComments>23</NoOfComments>
<OriginatorId>24</OriginatorId>
<TemplateId>25</TemplateId>
<WorkflowType>26</WorkflowType>
</DashBoardViewModel>
</Response>
</ReturnObjectOfListOfDashBoardViewModel>