GET api/GetDocumentsByStatus?statusId={statusId}&PageNumber={PageNumber}&Year={Year}

Request Information

URI Parameters

Name	Type	Additional information
statusId	string	Required
PageNumber	string	Required
Year	string	Default value is

Body Parameters

None.

Response Information

Resource Description

ReturnObjectOfListOfDocumentInformation

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

Response Formats

application/json, text/json

Sample:

{
  "IsSuccess": true,
  "Messages": [
    "sample string 1",
    "sample string 2"
  ],
  "ErrorCode": 2,
  "Response": [
    {
      "totalRecords": 1,
      "WorkFlowId": 2,
      "Name": "sample string 3",
      "UploadTime": "sample string 4",
      "DisplayName": "sample string 5",
      "OriginatorId": 6,
      "CategoryName": "sample string 7",
      "DocumentNumber": "sample string 8",
      "ReferenceNo": "sample string 9",
      "Status": "sample string 10",
      "DocumentId": 11,
      "WorkflowType": 12,
      "NoofAttachment": true,
      "SignatureType": 14,
      "Department": "sample string 15",
      "Comments": "sample string 16",
      "LotId": 17,
      "MenuID": 18,
      "PfOrder": 19,
      "AddExceptionalUser": true,
      "Delegatedto": 21,
      "DelegatedBy": "sample string 22",
      "NoOfDocsCount": 23,
      "IsSigner": true,
      "DeclinedDate": "sample string 25",
      "RecalledDate": "sample string 26",
      "ThumbnailBase64": "sample string 27",
      "InitiateBy": "sample string 28"
    },
    {
      "totalRecords": 1,
      "WorkFlowId": 2,
      "Name": "sample string 3",
      "UploadTime": "sample string 4",
      "DisplayName": "sample string 5",
      "OriginatorId": 6,
      "CategoryName": "sample string 7",
      "DocumentNumber": "sample string 8",
      "ReferenceNo": "sample string 9",
      "Status": "sample string 10",
      "DocumentId": 11,
      "WorkflowType": 12,
      "NoofAttachment": true,
      "SignatureType": 14,
      "Department": "sample string 15",
      "Comments": "sample string 16",
      "LotId": 17,
      "MenuID": 18,
      "PfOrder": 19,
      "AddExceptionalUser": true,
      "Delegatedto": 21,
      "DelegatedBy": "sample string 22",
      "NoOfDocsCount": 23,
      "IsSigner": true,
      "DeclinedDate": "sample string 25",
      "RecalledDate": "sample string 26",
      "ThumbnailBase64": "sample string 27",
      "InitiateBy": "sample string 28"
    }
  ]
}

application/xml, text/xml

Sample:

<ReturnObjectOfListOfDocumentInformation 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>
    <DocumentInformation>
      <totalRecords>1</totalRecords>
      <WorkFlowId>2</WorkFlowId>
      <Name>sample string 3</Name>
      <UploadTime>sample string 4</UploadTime>
      <DisplayName>sample string 5</DisplayName>
      <OriginatorId>6</OriginatorId>
      <CategoryName>sample string 7</CategoryName>
      <DocumentNumber>sample string 8</DocumentNumber>
      <ReferenceNo>sample string 9</ReferenceNo>
      <Status>sample string 10</Status>
      <DocumentId>11</DocumentId>
      <WorkflowType>12</WorkflowType>
      <NoofAttachment>true</NoofAttachment>
      <SignatureType>14</SignatureType>
      <Department>sample string 15</Department>
      <Comments>sample string 16</Comments>
      <LotId>17</LotId>
      <MenuID>18</MenuID>
      <PfOrder>19</PfOrder>
      <AddExceptionalUser>true</AddExceptionalUser>
      <Delegatedto>21</Delegatedto>
      <DelegatedBy>sample string 22</DelegatedBy>
      <NoOfDocsCount>23</NoOfDocsCount>
      <IsSigner>true</IsSigner>
      <DeclinedDate>sample string 25</DeclinedDate>
      <RecalledDate>sample string 26</RecalledDate>
      <ThumbnailBase64>sample string 27</ThumbnailBase64>
      <InitiateBy>sample string 28</InitiateBy>
    </DocumentInformation>
    <DocumentInformation>
      <totalRecords>1</totalRecords>
      <WorkFlowId>2</WorkFlowId>
      <Name>sample string 3</Name>
      <UploadTime>sample string 4</UploadTime>
      <DisplayName>sample string 5</DisplayName>
      <OriginatorId>6</OriginatorId>
      <CategoryName>sample string 7</CategoryName>
      <DocumentNumber>sample string 8</DocumentNumber>
      <ReferenceNo>sample string 9</ReferenceNo>
      <Status>sample string 10</Status>
      <DocumentId>11</DocumentId>
      <WorkflowType>12</WorkflowType>
      <NoofAttachment>true</NoofAttachment>
      <SignatureType>14</SignatureType>
      <Department>sample string 15</Department>
      <Comments>sample string 16</Comments>
      <LotId>17</LotId>
      <MenuID>18</MenuID>
      <PfOrder>19</PfOrder>
      <AddExceptionalUser>true</AddExceptionalUser>
      <Delegatedto>21</Delegatedto>
      <DelegatedBy>sample string 22</DelegatedBy>
      <NoOfDocsCount>23</NoOfDocsCount>
      <IsSigner>true</IsSigner>
      <DeclinedDate>sample string 25</DeclinedDate>
      <RecalledDate>sample string 26</RecalledDate>
      <ThumbnailBase64>sample string 27</ThumbnailBase64>
      <InitiateBy>sample string 28</InitiateBy>
    </DocumentInformation>
  </Response>
</ReturnObjectOfListOfDocumentInformation>