GET api/appointments

Request Information

URI Parameters

Name	Type	Additional information
IsActive	boolean	None.
BookingStatus	Collection of string	None.
AppointmentFilterType	string	None.
DateFrom	date	None.
DateTo	date	None.
PageIndex	integer	None.
PageSize	integer	None.

Body Parameters

None.

Response Information

Resource Description

PaginationRespModelOfAppointmentSlotOutputModel

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 AppointmentSlotOutputModel	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",
      "ConsultationType": "sample string 2",
      "QueuingCount": "sample string 3",
      "EstimationTime": "sample string 4",
      "Remark": "sample string 5",
      "PractitionerId": "sample string 6",
      "PractitionerName": "sample string 7",
      "Speciality": "sample string 8",
      "BookingTime": "sample string 9",
      "AppointmentStartDate": "sample string 10",
      "AppointmentEndDate": "sample string 11",
      "Duration": "sample string 12",
      "Status": "sample string 13",
      "StatusColor": "sample string 14",
      "ConsultationDiagnosis": "sample string 15",
      "ConsultationDoctorSuggestion": "sample string 16",
      "IsActive": true,
      "IsAppointment": true,
      "ConsultationURL": "sample string 19",
      "MedicalCertURL": "sample string 20",
      "ReferralLetterURL": "sample string 21",
      "RejectReason": "sample string 22",
      "PatientName": "sample string 23",
      "PatientDOB": "sample string 24",
      "Gender": "sample string 25",
      "PatientAllergicRecord": "sample string 26"
    },
    {
      "Id": "sample string 1",
      "ConsultationType": "sample string 2",
      "QueuingCount": "sample string 3",
      "EstimationTime": "sample string 4",
      "Remark": "sample string 5",
      "PractitionerId": "sample string 6",
      "PractitionerName": "sample string 7",
      "Speciality": "sample string 8",
      "BookingTime": "sample string 9",
      "AppointmentStartDate": "sample string 10",
      "AppointmentEndDate": "sample string 11",
      "Duration": "sample string 12",
      "Status": "sample string 13",
      "StatusColor": "sample string 14",
      "ConsultationDiagnosis": "sample string 15",
      "ConsultationDoctorSuggestion": "sample string 16",
      "IsActive": true,
      "IsAppointment": true,
      "ConsultationURL": "sample string 19",
      "MedicalCertURL": "sample string 20",
      "ReferralLetterURL": "sample string 21",
      "RejectReason": "sample string 22",
      "PatientName": "sample string 23",
      "PatientDOB": "sample string 24",
      "Gender": "sample string 25",
      "PatientAllergicRecord": "sample string 26"
    }
  ]
}

application/xml, text/xml

Sample:

<PaginationRespModelOfAppointmentSlotOutputModelsdLWh09w xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HyperQB.Property.API.Models">
  <CurrentPage>1</CurrentPage>
  <Data>
    <AppointmentSlotOutputModel>
      <AppointmentEndDate>sample string 11</AppointmentEndDate>
      <AppointmentStartDate>sample string 10</AppointmentStartDate>
      <BookingTime>sample string 9</BookingTime>
      <ConsultationDiagnosis>sample string 15</ConsultationDiagnosis>
      <ConsultationDoctorSuggestion>sample string 16</ConsultationDoctorSuggestion>
      <ConsultationType>sample string 2</ConsultationType>
      <ConsultationURL>sample string 19</ConsultationURL>
      <Duration>sample string 12</Duration>
      <EstimationTime>sample string 4</EstimationTime>
      <Gender>sample string 25</Gender>
      <Id>sample string 1</Id>
      <IsActive>true</IsActive>
      <IsAppointment>true</IsAppointment>
      <MedicalCertURL>sample string 20</MedicalCertURL>
      <PatientAllergicRecord>sample string 26</PatientAllergicRecord>
      <PatientDOB>sample string 24</PatientDOB>
      <PatientName>sample string 23</PatientName>
      <PractitionerId>sample string 6</PractitionerId>
      <PractitionerName>sample string 7</PractitionerName>
      <QueuingCount>sample string 3</QueuingCount>
      <ReferralLetterURL>sample string 21</ReferralLetterURL>
      <RejectReason>sample string 22</RejectReason>
      <Remark>sample string 5</Remark>
      <Speciality>sample string 8</Speciality>
      <Status>sample string 13</Status>
      <StatusColor>sample string 14</StatusColor>
    </AppointmentSlotOutputModel>
    <AppointmentSlotOutputModel>
      <AppointmentEndDate>sample string 11</AppointmentEndDate>
      <AppointmentStartDate>sample string 10</AppointmentStartDate>
      <BookingTime>sample string 9</BookingTime>
      <ConsultationDiagnosis>sample string 15</ConsultationDiagnosis>
      <ConsultationDoctorSuggestion>sample string 16</ConsultationDoctorSuggestion>
      <ConsultationType>sample string 2</ConsultationType>
      <ConsultationURL>sample string 19</ConsultationURL>
      <Duration>sample string 12</Duration>
      <EstimationTime>sample string 4</EstimationTime>
      <Gender>sample string 25</Gender>
      <Id>sample string 1</Id>
      <IsActive>true</IsActive>
      <IsAppointment>true</IsAppointment>
      <MedicalCertURL>sample string 20</MedicalCertURL>
      <PatientAllergicRecord>sample string 26</PatientAllergicRecord>
      <PatientDOB>sample string 24</PatientDOB>
      <PatientName>sample string 23</PatientName>
      <PractitionerId>sample string 6</PractitionerId>
      <PractitionerName>sample string 7</PractitionerName>
      <QueuingCount>sample string 3</QueuingCount>
      <ReferralLetterURL>sample string 21</ReferralLetterURL>
      <RejectReason>sample string 22</RejectReason>
      <Remark>sample string 5</Remark>
      <Speciality>sample string 8</Speciality>
      <Status>sample string 13</Status>
      <StatusColor>sample string 14</StatusColor>
    </AppointmentSlotOutputModel>
  </Data>
  <From>5</From>
  <LastPage>2</LastPage>
  <PerPage>3</PerPage>
  <To>6</To>
  <Total>4</Total>
</PaginationRespModelOfAppointmentSlotOutputModelsdLWh09w>