GET api/appointments/search?locationId={locationId}&doctorId={doctorId}&externalId={externalId}&startDateOperator={startDateOperator}&start1={start1}&start2={start2}&status={status}&itemType={itemType}&page={page}&itemsPerPage={itemsPerPage}
Returns a list of appointments.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
locationId |
Unique ID of location |
globally unique identifier |
Required |
doctorId |
Unique ID of doctor |
globally unique identifier |
Required |
externalId |
Unique ID of appointment in integrating system |
string |
Default value is |
startDateOperator |
Operator used to filter the list based on the start date of the appointment. Possible values: NotCompare (equals to empty string ""), Equals, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, Between, DifferentThan, Contains, StartsWith |
string |
Default value is |
start1 |
Used to filter the list based on the start date of the appointment. |
date |
None. |
start2 |
Used to filter the list based on the start date of the appointment(only when comparison operator is Between). |
date |
None. |
status |
Current Status of an appointment. Possible values: PendingForReschedule, PendingForCancel, Cancelled, Scheduled and Rescheduled |
AppointmentGeneralStatus |
None. |
itemType |
Type of the appointment. Possible values: Appointment (Default), AppointmentRequest |
string |
Default value is |
page |
Page number requested (search results are paginated). |
integer |
Default value is 1 |
itemsPerPage |
Items to return on each page. See page parameter above. |
integer |
Default value is 10 |
Body Parameters
None.
Response Information
Resource Description
ListModelOfAppointmentModelName | Description | Type | Additional information |
---|---|---|---|
TotalItems | integer |
None. |
|
ItemsPerPage | integer |
None. |
|
CurrentPage | integer |
None. |
|
TotalPages | integer |
None. |
|
FirstRowOnPage | integer |
None. |
|
LastRowOnPage | integer |
None. |
|
Rows | Collection of AppointmentModel |
None. |
Response Formats
application/json, text/json
{ "TotalItems": 1, "ItemsPerPage": 2, "CurrentPage": 3, "TotalPages": 4, "FirstRowOnPage": 5, "LastRowOnPage": 6, "Rows": [ { "Id": "40896239-5118-41a8-8126-77edd4fc5f3b", "ItemType": "sample string 2", "ExternalId": "sample string 3", "LocationId": "cc5b4c16-8170-4f60-ae24-108ca025c80b", "LocationName": "sample string 5", "LocationPhoneNumber": "sample string 6", "LocationEmailAddress": "sample string 7", "LocationPostalAddress": { "Id": "4d6c8018-beb3-4b99-a14e-bd7110aedca3", "Alias": "sample string 2", "Address1": "sample string 3", "Address2": "sample string 4", "City": "sample string 5", "State": "sample string 6", "CountryId": "ee358e21-458f-448f-b203-03304b7d9448", "CountryCode": "sample string 7", "CountryName": "sample string 8", "Zip": "sample string 9", "Default": true, "Latitude": 1.0, "Longitude": 1.0 }, "DoctorId": "947b6c2d-4962-42dd-80bd-7679e0e38bd0", "DoctorFirstName": "sample string 9", "DoctorLastName": "sample string 10", "DoctorFullName": "sample string 11", "Status": "sample string 12", "Start": "sample string 13", "End": "sample string 14", "SelectedDateRange": "sample string 15", "PreferredDays": "sample string 16", "SelectedPreferredTime": "sample string 17", "RequestType": "sample string 18" }, { "Id": "40896239-5118-41a8-8126-77edd4fc5f3b", "ItemType": "sample string 2", "ExternalId": "sample string 3", "LocationId": "cc5b4c16-8170-4f60-ae24-108ca025c80b", "LocationName": "sample string 5", "LocationPhoneNumber": "sample string 6", "LocationEmailAddress": "sample string 7", "LocationPostalAddress": { "Id": "4d6c8018-beb3-4b99-a14e-bd7110aedca3", "Alias": "sample string 2", "Address1": "sample string 3", "Address2": "sample string 4", "City": "sample string 5", "State": "sample string 6", "CountryId": "ee358e21-458f-448f-b203-03304b7d9448", "CountryCode": "sample string 7", "CountryName": "sample string 8", "Zip": "sample string 9", "Default": true, "Latitude": 1.0, "Longitude": 1.0 }, "DoctorId": "947b6c2d-4962-42dd-80bd-7679e0e38bd0", "DoctorFirstName": "sample string 9", "DoctorLastName": "sample string 10", "DoctorFullName": "sample string 11", "Status": "sample string 12", "Start": "sample string 13", "End": "sample string 14", "SelectedDateRange": "sample string 15", "PreferredDays": "sample string 16", "SelectedPreferredTime": "sample string 17", "RequestType": "sample string 18" } ] }
application/xml, text/xml
<ListModelOfAppointmentModelTlh5074t xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GlobalPortal.Mobile.Api.Models"> <CurrentPage>3</CurrentPage> <FirstRowOnPage>5</FirstRowOnPage> <ItemsPerPage>2</ItemsPerPage> <LastRowOnPage>6</LastRowOnPage> <Rows xmlns:d2p1="http://schemas.datacontract.org/2004/07/GlobalPortal.Mobile.Api.Models.Appointments"> <d2p1:AppointmentModel> <d2p1:DoctorFirstName>sample string 9</d2p1:DoctorFirstName> <d2p1:DoctorFullName>sample string 11</d2p1:DoctorFullName> <d2p1:DoctorId>947b6c2d-4962-42dd-80bd-7679e0e38bd0</d2p1:DoctorId> <d2p1:DoctorLastName>sample string 10</d2p1:DoctorLastName> <d2p1:End>sample string 14</d2p1:End> <d2p1:ExternalId>sample string 3</d2p1:ExternalId> <d2p1:Id>40896239-5118-41a8-8126-77edd4fc5f3b</d2p1:Id> <d2p1:ItemType>sample string 2</d2p1:ItemType> <d2p1:LocationEmailAddress>sample string 7</d2p1:LocationEmailAddress> <d2p1:LocationId>cc5b4c16-8170-4f60-ae24-108ca025c80b</d2p1:LocationId> <d2p1:LocationName>sample string 5</d2p1:LocationName> <d2p1:LocationPhoneNumber>sample string 6</d2p1:LocationPhoneNumber> <d2p1:LocationPostalAddress xmlns:d4p1="http://schemas.datacontract.org/2004/07/GlobalPortal.Mobile.Api.Models.Contacts"> <d4p1:Address1>sample string 3</d4p1:Address1> <d4p1:Address2>sample string 4</d4p1:Address2> <d4p1:Alias>sample string 2</d4p1:Alias> <d4p1:City>sample string 5</d4p1:City> <d4p1:CountryCode>sample string 7</d4p1:CountryCode> <d4p1:CountryId>ee358e21-458f-448f-b203-03304b7d9448</d4p1:CountryId> <d4p1:CountryName>sample string 8</d4p1:CountryName> <d4p1:Default>true</d4p1:Default> <d4p1:Id>4d6c8018-beb3-4b99-a14e-bd7110aedca3</d4p1:Id> <d4p1:Latitude>1</d4p1:Latitude> <d4p1:Longitude>1</d4p1:Longitude> <d4p1:State>sample string 6</d4p1:State> <d4p1:Zip>sample string 9</d4p1:Zip> </d2p1:LocationPostalAddress> <d2p1:PreferredDays>sample string 16</d2p1:PreferredDays> <d2p1:RequestType>sample string 18</d2p1:RequestType> <d2p1:SelectedDateRange>sample string 15</d2p1:SelectedDateRange> <d2p1:SelectedPreferredTime>sample string 17</d2p1:SelectedPreferredTime> <d2p1:Start>sample string 13</d2p1:Start> <d2p1:Status>sample string 12</d2p1:Status> </d2p1:AppointmentModel> <d2p1:AppointmentModel> <d2p1:DoctorFirstName>sample string 9</d2p1:DoctorFirstName> <d2p1:DoctorFullName>sample string 11</d2p1:DoctorFullName> <d2p1:DoctorId>947b6c2d-4962-42dd-80bd-7679e0e38bd0</d2p1:DoctorId> <d2p1:DoctorLastName>sample string 10</d2p1:DoctorLastName> <d2p1:End>sample string 14</d2p1:End> <d2p1:ExternalId>sample string 3</d2p1:ExternalId> <d2p1:Id>40896239-5118-41a8-8126-77edd4fc5f3b</d2p1:Id> <d2p1:ItemType>sample string 2</d2p1:ItemType> <d2p1:LocationEmailAddress>sample string 7</d2p1:LocationEmailAddress> <d2p1:LocationId>cc5b4c16-8170-4f60-ae24-108ca025c80b</d2p1:LocationId> <d2p1:LocationName>sample string 5</d2p1:LocationName> <d2p1:LocationPhoneNumber>sample string 6</d2p1:LocationPhoneNumber> <d2p1:LocationPostalAddress xmlns:d4p1="http://schemas.datacontract.org/2004/07/GlobalPortal.Mobile.Api.Models.Contacts"> <d4p1:Address1>sample string 3</d4p1:Address1> <d4p1:Address2>sample string 4</d4p1:Address2> <d4p1:Alias>sample string 2</d4p1:Alias> <d4p1:City>sample string 5</d4p1:City> <d4p1:CountryCode>sample string 7</d4p1:CountryCode> <d4p1:CountryId>ee358e21-458f-448f-b203-03304b7d9448</d4p1:CountryId> <d4p1:CountryName>sample string 8</d4p1:CountryName> <d4p1:Default>true</d4p1:Default> <d4p1:Id>4d6c8018-beb3-4b99-a14e-bd7110aedca3</d4p1:Id> <d4p1:Latitude>1</d4p1:Latitude> <d4p1:Longitude>1</d4p1:Longitude> <d4p1:State>sample string 6</d4p1:State> <d4p1:Zip>sample string 9</d4p1:Zip> </d2p1:LocationPostalAddress> <d2p1:PreferredDays>sample string 16</d2p1:PreferredDays> <d2p1:RequestType>sample string 18</d2p1:RequestType> <d2p1:SelectedDateRange>sample string 15</d2p1:SelectedDateRange> <d2p1:SelectedPreferredTime>sample string 17</d2p1:SelectedPreferredTime> <d2p1:Start>sample string 13</d2p1:Start> <d2p1:Status>sample string 12</d2p1:Status> </d2p1:AppointmentModel> </Rows> <TotalItems>1</TotalItems> <TotalPages>4</TotalPages> </ListModelOfAppointmentModelTlh5074t>