GET api/ProviderService/GetAppointments?practiceID={practiceID}&providerID={providerID}&selectedDate={selectedDate}

Get Appointments

Request Information

URI Parameters

Name	Type	Additional information
practiceID	globally unique identifier	Required
providerID	globally unique identifier	Required
selectedDate	date	Required

Body Parameters

None.

Response Information

Resource Description

SchedularAppointments

Name	Type	Additional information
Appointments	Collection of AppointmentInfo	None.
StartOfWeek	date	None.
EndOfWeek	date	None.

Response Formats

application/json, text/json

Sample:

{
  "Appointments": [
    {
      "NewPatient": true,
      "Appointment_Id": "a159195f-9fe4-4f1a-b483-48b14d3ae9d4",
      "Appointment_Type_Id": 1,
      "Title": "sample string 2",
      "Start_Date": "2025-06-08T01:53:03.8249758+00:00",
      "End_Date": "2025-06-08T01:53:03.8249758+00:00",
      "Duration": 1.1,
      "Description": "sample string 4",
      "Priority": "sample string 5",
      "Appointment_Status_Id": 1,
      "Parent_Appointment_Id": 1,
      "Cancelled_On": "2025-06-08T01:53:03.8249758+00:00",
      "Cancelled_By": "sample string 6",
      "Cancelled_Reason": "sample string 7",
      "Patient_Id": "baf9ef87-fc0b-4409-bb78-2cc247cc2c90",
      "Practice_Id": "403f65e2-ca72-420e-aacf-fc90624e9940",
      "Provider_Id": "96153721-0936-4220-8db1-c4111cd16716",
      "Recurrence_Id": "sample string 11",
      "Recurrence_Rule": "sample string 12",
      "Recurrence_Exception": "sample string 13",
      "Is_All_Day": true,
      "Start_Timezone": 1,
      "End_Timezone": 1,
      "Full_Name": "sample string 14",
      "Mobile_Number": "sample string 15",
      "InConsult_Id": "29f064bc-3cfb-4ac1-a979-a338a4af440a",
      "Arrival_Date": "2025-06-08T01:53:03.8249758+00:00",
      "WaitingTime": 1,
      "InConsultTime": 1,
      "AppointmentStatus": "sample string 16",
      "InConsult_EndDate": "2025-06-08T01:53:03.8249758+00:00",
      "History": "sample string 17",
      "Examination": "sample string 18",
      "Diagnosis": "sample string 19",
      "Treatment_Plan": "sample string 20",
      "Room_Id": "d78089d2-1630-4511-8390-04ca7904b7a9",
      "Room_Name": "sample string 21",
      "ImageName": "sample string 22",
      "Default_UI_Color": "sample string 23",
      "ProviderUserName": "sample string 24",
      "ProviderFullName": "sample string 25",
      "ExtraInfo": "sample string 26",
      "FacilityID": "e42c8d20-b31d-466e-8810-698d74e0276a",
      "FacilityName": "sample string 27",
      "Consulted": true,
      "Appt_Room_Id": "a7a58b11-9a49-4384-916d-12a8bef175fe",
      "CheckIn_DateInitial": "2025-06-08T01:53:03.8249758+00:00",
      "PatientFlags": "sample string 28",
      "Billing_Amount": 29.1,
      "Billing_Msg": "sample string 30",
      "MRNValue": "sample string 31",
      "MRN_Seed": 32,
      "DOB": "2025-06-08T01:53:03.8249758+00:00",
      "First_Name": "sample string 33",
      "Middle_Name": "sample string 34",
      "Sur_Name": "sample string 35",
      "Maiden_Name": "sample string 36",
      "IsNewPatientAppointment": true,
      "InitialCheckInTime": "sample string 37",
      "taskId": "a159195f-9fe4-4f1a-b483-48b14d3ae9d4",
      "IsInWaitingRoom": true,
      "PatientName": "sample string 39",
      "Patient_Name": "sample string 39"
    },
    {
      "NewPatient": true,
      "Appointment_Id": "a159195f-9fe4-4f1a-b483-48b14d3ae9d4",
      "Appointment_Type_Id": 1,
      "Title": "sample string 2",
      "Start_Date": "2025-06-08T01:53:03.8249758+00:00",
      "End_Date": "2025-06-08T01:53:03.8249758+00:00",
      "Duration": 1.1,
      "Description": "sample string 4",
      "Priority": "sample string 5",
      "Appointment_Status_Id": 1,
      "Parent_Appointment_Id": 1,
      "Cancelled_On": "2025-06-08T01:53:03.8249758+00:00",
      "Cancelled_By": "sample string 6",
      "Cancelled_Reason": "sample string 7",
      "Patient_Id": "baf9ef87-fc0b-4409-bb78-2cc247cc2c90",
      "Practice_Id": "403f65e2-ca72-420e-aacf-fc90624e9940",
      "Provider_Id": "96153721-0936-4220-8db1-c4111cd16716",
      "Recurrence_Id": "sample string 11",
      "Recurrence_Rule": "sample string 12",
      "Recurrence_Exception": "sample string 13",
      "Is_All_Day": true,
      "Start_Timezone": 1,
      "End_Timezone": 1,
      "Full_Name": "sample string 14",
      "Mobile_Number": "sample string 15",
      "InConsult_Id": "29f064bc-3cfb-4ac1-a979-a338a4af440a",
      "Arrival_Date": "2025-06-08T01:53:03.8249758+00:00",
      "WaitingTime": 1,
      "InConsultTime": 1,
      "AppointmentStatus": "sample string 16",
      "InConsult_EndDate": "2025-06-08T01:53:03.8249758+00:00",
      "History": "sample string 17",
      "Examination": "sample string 18",
      "Diagnosis": "sample string 19",
      "Treatment_Plan": "sample string 20",
      "Room_Id": "d78089d2-1630-4511-8390-04ca7904b7a9",
      "Room_Name": "sample string 21",
      "ImageName": "sample string 22",
      "Default_UI_Color": "sample string 23",
      "ProviderUserName": "sample string 24",
      "ProviderFullName": "sample string 25",
      "ExtraInfo": "sample string 26",
      "FacilityID": "e42c8d20-b31d-466e-8810-698d74e0276a",
      "FacilityName": "sample string 27",
      "Consulted": true,
      "Appt_Room_Id": "a7a58b11-9a49-4384-916d-12a8bef175fe",
      "CheckIn_DateInitial": "2025-06-08T01:53:03.8249758+00:00",
      "PatientFlags": "sample string 28",
      "Billing_Amount": 29.1,
      "Billing_Msg": "sample string 30",
      "MRNValue": "sample string 31",
      "MRN_Seed": 32,
      "DOB": "2025-06-08T01:53:03.8249758+00:00",
      "First_Name": "sample string 33",
      "Middle_Name": "sample string 34",
      "Sur_Name": "sample string 35",
      "Maiden_Name": "sample string 36",
      "IsNewPatientAppointment": true,
      "InitialCheckInTime": "sample string 37",
      "taskId": "a159195f-9fe4-4f1a-b483-48b14d3ae9d4",
      "IsInWaitingRoom": true,
      "PatientName": "sample string 39",
      "Patient_Name": "sample string 39"
    }
  ],
  "StartOfWeek": "2025-06-08T01:53:03.8249758+00:00",
  "EndOfWeek": "2025-06-08T01:53:03.8249758+00:00"
}

application/xml, text/xml

Sample:

<SchedularAppointments xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/EMR.Web.Screens.Models">
  <Appointments xmlns:d2p1="http://schemas.datacontract.org/2004/07/CSP.EMRContexts.Common.ViewModels">
    <d2p1:AppointmentInfo>
      <d2p1:AppointmentStatus>sample string 16</d2p1:AppointmentStatus>
      <d2p1:Appointment_Id>a159195f-9fe4-4f1a-b483-48b14d3ae9d4</d2p1:Appointment_Id>
      <d2p1:Appointment_Status_Id>1</d2p1:Appointment_Status_Id>
      <d2p1:Appointment_Type_Id>1</d2p1:Appointment_Type_Id>
      <d2p1:Appt_Room_Id>a7a58b11-9a49-4384-916d-12a8bef175fe</d2p1:Appt_Room_Id>
      <d2p1:Arrival_Date>2025-06-08T01:53:03.8249758+00:00</d2p1:Arrival_Date>
      <d2p1:Billing_Amount>29.1</d2p1:Billing_Amount>
      <d2p1:Billing_Msg>sample string 30</d2p1:Billing_Msg>
      <d2p1:Cancelled_By>sample string 6</d2p1:Cancelled_By>
      <d2p1:Cancelled_On>2025-06-08T01:53:03.8249758+00:00</d2p1:Cancelled_On>
      <d2p1:Cancelled_Reason>sample string 7</d2p1:Cancelled_Reason>
      <d2p1:CheckIn_DateInitial>2025-06-08T01:53:03.8249758+00:00</d2p1:CheckIn_DateInitial>
      <d2p1:Consulted>true</d2p1:Consulted>
      <d2p1:DOB>2025-06-08T01:53:03.8249758+00:00</d2p1:DOB>
      <d2p1:Default_UI_Color>sample string 23</d2p1:Default_UI_Color>
      <d2p1:Description>sample string 4</d2p1:Description>
      <d2p1:Diagnosis>sample string 19</d2p1:Diagnosis>
      <d2p1:Duration>1.1</d2p1:Duration>
      <d2p1:End_Date>2025-06-08T01:53:03.8249758+00:00</d2p1:End_Date>
      <d2p1:End_Timezone>1</d2p1:End_Timezone>
      <d2p1:Examination>sample string 18</d2p1:Examination>
      <d2p1:ExtraInfo>sample string 26</d2p1:ExtraInfo>
      <d2p1:FacilityID>e42c8d20-b31d-466e-8810-698d74e0276a</d2p1:FacilityID>
      <d2p1:FacilityName>sample string 27</d2p1:FacilityName>
      <d2p1:First_Name>sample string 33</d2p1:First_Name>
      <d2p1:Full_Name>sample string 14</d2p1:Full_Name>
      <d2p1:History>sample string 17</d2p1:History>
      <d2p1:ImageName>sample string 22</d2p1:ImageName>
      <d2p1:InConsultTime>1</d2p1:InConsultTime>
      <d2p1:InConsult_EndDate>2025-06-08T01:53:03.8249758+00:00</d2p1:InConsult_EndDate>
      <d2p1:InConsult_Id>29f064bc-3cfb-4ac1-a979-a338a4af440a</d2p1:InConsult_Id>
      <d2p1:InitialCheckInTime>sample string 37</d2p1:InitialCheckInTime>
      <d2p1:IsInWaitingRoom>true</d2p1:IsInWaitingRoom>
      <d2p1:IsNewPatientAppointment>true</d2p1:IsNewPatientAppointment>
      <d2p1:Is_All_Day>true</d2p1:Is_All_Day>
      <d2p1:MRNValue>sample string 31</d2p1:MRNValue>
      <d2p1:MRN_Seed>32</d2p1:MRN_Seed>
      <d2p1:Maiden_Name>sample string 36</d2p1:Maiden_Name>
      <d2p1:Middle_Name>sample string 34</d2p1:Middle_Name>
      <d2p1:Mobile_Number>sample string 15</d2p1:Mobile_Number>
      <d2p1:NewPatient>true</d2p1:NewPatient>
      <d2p1:Parent_Appointment_Id>1</d2p1:Parent_Appointment_Id>
      <d2p1:PatientFlags>sample string 28</d2p1:PatientFlags>
      <d2p1:PatientName>sample string 39</d2p1:PatientName>
      <d2p1:Patient_Id>baf9ef87-fc0b-4409-bb78-2cc247cc2c90</d2p1:Patient_Id>
      <d2p1:Practice_Id>403f65e2-ca72-420e-aacf-fc90624e9940</d2p1:Practice_Id>
      <d2p1:Priority>sample string 5</d2p1:Priority>
      <d2p1:ProviderFullName>sample string 25</d2p1:ProviderFullName>
      <d2p1:ProviderUserName>sample string 24</d2p1:ProviderUserName>
      <d2p1:Provider_Id>96153721-0936-4220-8db1-c4111cd16716</d2p1:Provider_Id>
      <d2p1:Recurrence_Exception>sample string 13</d2p1:Recurrence_Exception>
      <d2p1:Recurrence_Id>sample string 11</d2p1:Recurrence_Id>
      <d2p1:Recurrence_Rule>sample string 12</d2p1:Recurrence_Rule>
      <d2p1:Room_Id>d78089d2-1630-4511-8390-04ca7904b7a9</d2p1:Room_Id>
      <d2p1:Room_Name>sample string 21</d2p1:Room_Name>
      <d2p1:Start_Date>2025-06-08T01:53:03.8249758+00:00</d2p1:Start_Date>
      <d2p1:Start_Timezone>1</d2p1:Start_Timezone>
      <d2p1:Sur_Name>sample string 35</d2p1:Sur_Name>
      <d2p1:Title>sample string 2</d2p1:Title>
      <d2p1:Treatment_Plan>sample string 20</d2p1:Treatment_Plan>
      <d2p1:WaitingTime>1</d2p1:WaitingTime>
    </d2p1:AppointmentInfo>
    <d2p1:AppointmentInfo>
      <d2p1:AppointmentStatus>sample string 16</d2p1:AppointmentStatus>
      <d2p1:Appointment_Id>a159195f-9fe4-4f1a-b483-48b14d3ae9d4</d2p1:Appointment_Id>
      <d2p1:Appointment_Status_Id>1</d2p1:Appointment_Status_Id>
      <d2p1:Appointment_Type_Id>1</d2p1:Appointment_Type_Id>
      <d2p1:Appt_Room_Id>a7a58b11-9a49-4384-916d-12a8bef175fe</d2p1:Appt_Room_Id>
      <d2p1:Arrival_Date>2025-06-08T01:53:03.8249758+00:00</d2p1:Arrival_Date>
      <d2p1:Billing_Amount>29.1</d2p1:Billing_Amount>
      <d2p1:Billing_Msg>sample string 30</d2p1:Billing_Msg>
      <d2p1:Cancelled_By>sample string 6</d2p1:Cancelled_By>
      <d2p1:Cancelled_On>2025-06-08T01:53:03.8249758+00:00</d2p1:Cancelled_On>
      <d2p1:Cancelled_Reason>sample string 7</d2p1:Cancelled_Reason>
      <d2p1:CheckIn_DateInitial>2025-06-08T01:53:03.8249758+00:00</d2p1:CheckIn_DateInitial>
      <d2p1:Consulted>true</d2p1:Consulted>
      <d2p1:DOB>2025-06-08T01:53:03.8249758+00:00</d2p1:DOB>
      <d2p1:Default_UI_Color>sample string 23</d2p1:Default_UI_Color>
      <d2p1:Description>sample string 4</d2p1:Description>
      <d2p1:Diagnosis>sample string 19</d2p1:Diagnosis>
      <d2p1:Duration>1.1</d2p1:Duration>
      <d2p1:End_Date>2025-06-08T01:53:03.8249758+00:00</d2p1:End_Date>
      <d2p1:End_Timezone>1</d2p1:End_Timezone>
      <d2p1:Examination>sample string 18</d2p1:Examination>
      <d2p1:ExtraInfo>sample string 26</d2p1:ExtraInfo>
      <d2p1:FacilityID>e42c8d20-b31d-466e-8810-698d74e0276a</d2p1:FacilityID>
      <d2p1:FacilityName>sample string 27</d2p1:FacilityName>
      <d2p1:First_Name>sample string 33</d2p1:First_Name>
      <d2p1:Full_Name>sample string 14</d2p1:Full_Name>
      <d2p1:History>sample string 17</d2p1:History>
      <d2p1:ImageName>sample string 22</d2p1:ImageName>
      <d2p1:InConsultTime>1</d2p1:InConsultTime>
      <d2p1:InConsult_EndDate>2025-06-08T01:53:03.8249758+00:00</d2p1:InConsult_EndDate>
      <d2p1:InConsult_Id>29f064bc-3cfb-4ac1-a979-a338a4af440a</d2p1:InConsult_Id>
      <d2p1:InitialCheckInTime>sample string 37</d2p1:InitialCheckInTime>
      <d2p1:IsInWaitingRoom>true</d2p1:IsInWaitingRoom>
      <d2p1:IsNewPatientAppointment>true</d2p1:IsNewPatientAppointment>
      <d2p1:Is_All_Day>true</d2p1:Is_All_Day>
      <d2p1:MRNValue>sample string 31</d2p1:MRNValue>
      <d2p1:MRN_Seed>32</d2p1:MRN_Seed>
      <d2p1:Maiden_Name>sample string 36</d2p1:Maiden_Name>
      <d2p1:Middle_Name>sample string 34</d2p1:Middle_Name>
      <d2p1:Mobile_Number>sample string 15</d2p1:Mobile_Number>
      <d2p1:NewPatient>true</d2p1:NewPatient>
      <d2p1:Parent_Appointment_Id>1</d2p1:Parent_Appointment_Id>
      <d2p1:PatientFlags>sample string 28</d2p1:PatientFlags>
      <d2p1:PatientName>sample string 39</d2p1:PatientName>
      <d2p1:Patient_Id>baf9ef87-fc0b-4409-bb78-2cc247cc2c90</d2p1:Patient_Id>
      <d2p1:Practice_Id>403f65e2-ca72-420e-aacf-fc90624e9940</d2p1:Practice_Id>
      <d2p1:Priority>sample string 5</d2p1:Priority>
      <d2p1:ProviderFullName>sample string 25</d2p1:ProviderFullName>
      <d2p1:ProviderUserName>sample string 24</d2p1:ProviderUserName>
      <d2p1:Provider_Id>96153721-0936-4220-8db1-c4111cd16716</d2p1:Provider_Id>
      <d2p1:Recurrence_Exception>sample string 13</d2p1:Recurrence_Exception>
      <d2p1:Recurrence_Id>sample string 11</d2p1:Recurrence_Id>
      <d2p1:Recurrence_Rule>sample string 12</d2p1:Recurrence_Rule>
      <d2p1:Room_Id>d78089d2-1630-4511-8390-04ca7904b7a9</d2p1:Room_Id>
      <d2p1:Room_Name>sample string 21</d2p1:Room_Name>
      <d2p1:Start_Date>2025-06-08T01:53:03.8249758+00:00</d2p1:Start_Date>
      <d2p1:Start_Timezone>1</d2p1:Start_Timezone>
      <d2p1:Sur_Name>sample string 35</d2p1:Sur_Name>
      <d2p1:Title>sample string 2</d2p1:Title>
      <d2p1:Treatment_Plan>sample string 20</d2p1:Treatment_Plan>
      <d2p1:WaitingTime>1</d2p1:WaitingTime>
    </d2p1:AppointmentInfo>
  </Appointments>
  <EndOfWeek>2025-06-08T01:53:03.8249758+00:00</EndOfWeek>
  <StartOfWeek>2025-06-08T01:53:03.8249758+00:00</StartOfWeek>
</SchedularAppointments>