GET api/documents?Search={Search}&PageIndex={PageIndex}&PageSize={PageSize}

Request Information

URI Parameters

Name	Type	Additional information
Search	string	None.
PageIndex	integer	None.
PageSize	integer	None.

Body Parameters

None.

Response Information

Resource Description

PaginationRespModelOfDocumentOutputModel

Name	Type	Additional information
CurrentPage	integer	None.
LastPage	integer	None.
PerPage	integer	None.
Total	integer	None.
From	integer	None.
To	integer	None.
Data	Collection of DocumentOutputModel	None.

Response Formats

application/json, text/json

Sample:

{
  "CurrentPage": 1,
  "LastPage": 2,
  "PerPage": 3,
  "Total": 4,
  "From": 5,
  "To": 6,
  "Data": [
    {
      "ProjectName": "sample string 1",
      "UnitNo": "sample string 2",
      "Items": [
        {
          "Filename": "sample string 1",
          "Remark": "sample string 2",
          "Url": "sample string 3",
          "Date": "2024-09-28T11:18:10.6083716+08:00"
        },
        {
          "Filename": "sample string 1",
          "Remark": "sample string 2",
          "Url": "sample string 3",
          "Date": "2024-09-28T11:18:10.6083716+08:00"
        }
      ]
    },
    {
      "ProjectName": "sample string 1",
      "UnitNo": "sample string 2",
      "Items": [
        {
          "Filename": "sample string 1",
          "Remark": "sample string 2",
          "Url": "sample string 3",
          "Date": "2024-09-28T11:18:10.6083716+08:00"
        },
        {
          "Filename": "sample string 1",
          "Remark": "sample string 2",
          "Url": "sample string 3",
          "Date": "2024-09-28T11:18:10.6083716+08:00"
        }
      ]
    }
  ]
}

application/xml, text/xml

Sample:

<PaginationRespModelOfDocumentOutputModelpVZiKEaY xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HyperQB.ClientPropertyManagement.API.Models">
  <CurrentPage>1</CurrentPage>
  <Data>
    <DocumentOutputModel>
      <Items>
        <OutListItemForAgent>
          <Date>2024-09-28T11:18:10.6083716+08:00</Date>
          <Filename>sample string 1</Filename>
          <Remark>sample string 2</Remark>
          <Url>sample string 3</Url>
        </OutListItemForAgent>
        <OutListItemForAgent>
          <Date>2024-09-28T11:18:10.6083716+08:00</Date>
          <Filename>sample string 1</Filename>
          <Remark>sample string 2</Remark>
          <Url>sample string 3</Url>
        </OutListItemForAgent>
      </Items>
      <ProjectName>sample string 1</ProjectName>
      <UnitNo>sample string 2</UnitNo>
    </DocumentOutputModel>
    <DocumentOutputModel>
      <Items>
        <OutListItemForAgent>
          <Date>2024-09-28T11:18:10.6083716+08:00</Date>
          <Filename>sample string 1</Filename>
          <Remark>sample string 2</Remark>
          <Url>sample string 3</Url>
        </OutListItemForAgent>
        <OutListItemForAgent>
          <Date>2024-09-28T11:18:10.6083716+08:00</Date>
          <Filename>sample string 1</Filename>
          <Remark>sample string 2</Remark>
          <Url>sample string 3</Url>
        </OutListItemForAgent>
      </Items>
      <ProjectName>sample string 1</ProjectName>
      <UnitNo>sample string 2</UnitNo>
    </DocumentOutputModel>
  </Data>
  <From>5</From>
  <LastPage>2</LastPage>
  <PerPage>3</PerPage>
  <To>6</To>
  <Total>4</Total>
</PaginationRespModelOfDocumentOutputModelpVZiKEaY>