GET api/appointments?ProjectId={ProjectId}&UnitId={UnitId}&IsHistory={IsHistory}&DateFrom={DateFrom}&DateTo={DateTo}&PageIndex={PageIndex}&PageSize={PageSize}
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
ProjectId | string |
None. |
|
UnitId | string |
None. |
|
IsHistory | boolean |
None. |
|
DateFrom | date |
None. |
|
DateTo | date |
None. |
|
PageIndex | integer |
None. |
|
PageSize | integer |
None. |
Body Parameters
None.
Response Information
Resource Description
PaginationRespModelOfAppointmentOutputModelName | Description | Type | Additional information |
---|---|---|---|
CurrentPage | integer |
None. |
|
LastPage | integer |
None. |
|
PerPage | integer |
None. |
|
Total | integer |
None. |
|
From | integer |
None. |
|
To | integer |
None. |
|
Data | Collection of AppointmentOutputModel |
None. |
Response Formats
application/json, text/json
Sample:
{ "CurrentPage": 1, "LastPage": 2, "PerPage": 3, "Total": 4, "From": 5, "To": 6, "Data": [ { "ID": "sample string 1", "ProjectID": "sample string 2", "ProjectName": "sample string 3", "UnitID": "sample string 4", "UnitNo": "sample string 5", "Title": "sample string 6", "AgentID": "sample string 7", "AgentName": "sample string 8", "ServicesColor": "sample string 9", "ServicesType": "sample string 10", "VisitorID": "sample string 11", "VisitorName": "sample string 12", "VisitorContactNo": "sample string 13", "ImagePath": "sample string 14", "FullAddress": "sample string 15", "AppointmentDateStart": "2024-11-28T01:39:01.9406227+08:00", "AppointmentDateEnd": "2024-11-28T01:39:01.9406227+08:00", "AppointmentStatus": "sample string 16", "Agency": "sample string 17", "OwnerName": "sample string 18", "CloserId": "sample string 19", "CloserName": "sample string 20", "DateGRRStart": "2024-11-28T01:39:01.9406227+08:00", "DateGRREnd": "2024-11-28T01:39:01.9406227+08:00", "CountDownDay": 1, "DateMoveIn": "2024-11-28T01:39:01.9406227+08:00", "Type": "sample string 21", "AppointmentType": "sample string 22", "Status": "sample string 23", "UnitStatus": "sample string 24", "IsViewingDate": true }, { "ID": "sample string 1", "ProjectID": "sample string 2", "ProjectName": "sample string 3", "UnitID": "sample string 4", "UnitNo": "sample string 5", "Title": "sample string 6", "AgentID": "sample string 7", "AgentName": "sample string 8", "ServicesColor": "sample string 9", "ServicesType": "sample string 10", "VisitorID": "sample string 11", "VisitorName": "sample string 12", "VisitorContactNo": "sample string 13", "ImagePath": "sample string 14", "FullAddress": "sample string 15", "AppointmentDateStart": "2024-11-28T01:39:01.9406227+08:00", "AppointmentDateEnd": "2024-11-28T01:39:01.9406227+08:00", "AppointmentStatus": "sample string 16", "Agency": "sample string 17", "OwnerName": "sample string 18", "CloserId": "sample string 19", "CloserName": "sample string 20", "DateGRRStart": "2024-11-28T01:39:01.9406227+08:00", "DateGRREnd": "2024-11-28T01:39:01.9406227+08:00", "CountDownDay": 1, "DateMoveIn": "2024-11-28T01:39:01.9406227+08:00", "Type": "sample string 21", "AppointmentType": "sample string 22", "Status": "sample string 23", "UnitStatus": "sample string 24", "IsViewingDate": true } ] }
application/xml, text/xml
Sample:
<PaginationRespModelOfAppointmentOutputModelpVZiKEaY xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HyperQB.ClientPropertyManagement.API.Models"> <CurrentPage>1</CurrentPage> <Data> <AppointmentOutputModel> <Agency>sample string 17</Agency> <AgentID>sample string 7</AgentID> <AgentName>sample string 8</AgentName> <AppointmentDateEnd>2024-11-28T01:39:01.9406227+08:00</AppointmentDateEnd> <AppointmentDateStart>2024-11-28T01:39:01.9406227+08:00</AppointmentDateStart> <AppointmentStatus>sample string 16</AppointmentStatus> <AppointmentType>sample string 22</AppointmentType> <CloserId>sample string 19</CloserId> <CloserName>sample string 20</CloserName> <CountDownDay>1</CountDownDay> <DateGRREnd>2024-11-28T01:39:01.9406227+08:00</DateGRREnd> <DateGRRStart>2024-11-28T01:39:01.9406227+08:00</DateGRRStart> <DateMoveIn>2024-11-28T01:39:01.9406227+08:00</DateMoveIn> <FullAddress>sample string 15</FullAddress> <ID>sample string 1</ID> <ImagePath>sample string 14</ImagePath> <IsViewingDate>true</IsViewingDate> <OwnerName>sample string 18</OwnerName> <ProjectID>sample string 2</ProjectID> <ProjectName>sample string 3</ProjectName> <ServicesColor>sample string 9</ServicesColor> <ServicesType>sample string 10</ServicesType> <Status>sample string 23</Status> <Title>sample string 6</Title> <Type>sample string 21</Type> <UnitID>sample string 4</UnitID> <UnitNo>sample string 5</UnitNo> <UnitStatus>sample string 24</UnitStatus> <VisitorContactNo>sample string 13</VisitorContactNo> <VisitorID>sample string 11</VisitorID> <VisitorName>sample string 12</VisitorName> </AppointmentOutputModel> <AppointmentOutputModel> <Agency>sample string 17</Agency> <AgentID>sample string 7</AgentID> <AgentName>sample string 8</AgentName> <AppointmentDateEnd>2024-11-28T01:39:01.9406227+08:00</AppointmentDateEnd> <AppointmentDateStart>2024-11-28T01:39:01.9406227+08:00</AppointmentDateStart> <AppointmentStatus>sample string 16</AppointmentStatus> <AppointmentType>sample string 22</AppointmentType> <CloserId>sample string 19</CloserId> <CloserName>sample string 20</CloserName> <CountDownDay>1</CountDownDay> <DateGRREnd>2024-11-28T01:39:01.9406227+08:00</DateGRREnd> <DateGRRStart>2024-11-28T01:39:01.9406227+08:00</DateGRRStart> <DateMoveIn>2024-11-28T01:39:01.9406227+08:00</DateMoveIn> <FullAddress>sample string 15</FullAddress> <ID>sample string 1</ID> <ImagePath>sample string 14</ImagePath> <IsViewingDate>true</IsViewingDate> <OwnerName>sample string 18</OwnerName> <ProjectID>sample string 2</ProjectID> <ProjectName>sample string 3</ProjectName> <ServicesColor>sample string 9</ServicesColor> <ServicesType>sample string 10</ServicesType> <Status>sample string 23</Status> <Title>sample string 6</Title> <Type>sample string 21</Type> <UnitID>sample string 4</UnitID> <UnitNo>sample string 5</UnitNo> <UnitStatus>sample string 24</UnitStatus> <VisitorContactNo>sample string 13</VisitorContactNo> <VisitorID>sample string 11</VisitorID> <VisitorName>sample string 12</VisitorName> </AppointmentOutputModel> </Data> <From>5</From> <LastPage>2</LastPage> <PerPage>3</PerPage> <To>6</To> <Total>4</Total> </PaginationRespModelOfAppointmentOutputModelpVZiKEaY>