GET Appointment/GetAvailableSlotsAsyncParam

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
patientId	string	None.
endpoint_Identifier	string	None.
healthcareService_reference	string	None.
serviceType_code	string	None.
referenceDate	date	None.

Request Formats

application/json, text/json

Sample:

{
  "patientId": "sample string 1",
  "endpoint_Identifier": "sample string 2",
  "healthcareService_reference": "sample string 3",
  "serviceType_code": "sample string 4",
  "referenceDate": "2025-09-04T13:38:43.9275401+00:00"
}

application/xml, text/xml

Sample:

<GetAvailableSlotsParams xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AppointmentAPI.Entities">
  <endpoint_Identifier>sample string 2</endpoint_Identifier>
  <healthcareService_reference>sample string 3</healthcareService_reference>
  <patientId>sample string 1</patientId>
  <referenceDate>2025-09-04T13:38:43.9275401+00:00</referenceDate>
  <serviceType_code>sample string 4</serviceType_code>
</GetAvailableSlotsParams>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Collection of SlotInfo

Name	Type	Additional information
Organization_display	string	None.
Organization_reference	string	None.
Endpoint_identifier	string	None.
HealthcareService_display	string	None.
HealthcareService_reference	string	None.
ServiceType_code	string	None.
ServiceType_display	string	None.
SlotDateTime	date	None.
SlotTime	string	None.
SlotDate	string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "Organization_display": "sample string 1",
    "Organization_reference": "sample string 2",
    "Endpoint_identifier": "sample string 3",
    "HealthcareService_display": "sample string 4",
    "HealthcareService_reference": "sample string 5",
    "ServiceType_code": "sample string 6",
    "ServiceType_display": "sample string 7",
    "SlotDateTime": "2025-09-04T13:38:43.9275401+00:00",
    "SlotTime": "1:38 PM",
    "SlotDate": "9/4/2025"
  },
  {
    "Organization_display": "sample string 1",
    "Organization_reference": "sample string 2",
    "Endpoint_identifier": "sample string 3",
    "HealthcareService_display": "sample string 4",
    "HealthcareService_reference": "sample string 5",
    "ServiceType_code": "sample string 6",
    "ServiceType_display": "sample string 7",
    "SlotDateTime": "2025-09-04T13:38:43.9275401+00:00",
    "SlotTime": "1:38 PM",
    "SlotDate": "9/4/2025"
  }
]

application/xml, text/xml

Sample:

<ArrayOfSlotInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AppointmentAPI.Entities">
  <SlotInfo>
    <Endpoint_identifier>sample string 3</Endpoint_identifier>
    <HealthcareService_display>sample string 4</HealthcareService_display>
    <HealthcareService_reference>sample string 5</HealthcareService_reference>
    <Organization_display>sample string 1</Organization_display>
    <Organization_reference>sample string 2</Organization_reference>
    <ServiceType_code>sample string 6</ServiceType_code>
    <ServiceType_display>sample string 7</ServiceType_display>
    <SlotDateTime>2025-09-04T13:38:43.9275401+00:00</SlotDateTime>
  </SlotInfo>
  <SlotInfo>
    <Endpoint_identifier>sample string 3</Endpoint_identifier>
    <HealthcareService_display>sample string 4</HealthcareService_display>
    <HealthcareService_reference>sample string 5</HealthcareService_reference>
    <Organization_display>sample string 1</Organization_display>
    <Organization_reference>sample string 2</Organization_reference>
    <ServiceType_code>sample string 6</ServiceType_code>
    <ServiceType_display>sample string 7</ServiceType_display>
    <SlotDateTime>2025-09-04T13:38:43.9275401+00:00</SlotDateTime>
  </SlotInfo>
</ArrayOfSlotInfo>