Issue with appointment slot json response

Hi,

While reviewing the appointment slot (A015)

response payload in the Integration environment, I noticed that the format of the schedule.reference field differs from what is returned in the Sandbox environment.

Sandbox response:

“schedule”: {

"reference": "Schedule/12000-921600556514"

}

Integration response:

“schedule”: {

"reference": "Schedule/6709562"

}

The slot data is being returned successfully, but the reference value format has changed between the two environments. In the Integration environment, the reference contains only service ID (6709562), whereas in the Sandbox environment it contains a different format (12000-921600556514).

I have attached the response file received from the Integration environment for your reference.
Appointment_Slot_Response.txt (16.5 KB)

Could you please confirm whether this difference in the schedule.reference format is expected, or if there have been any recent changes in the Integration environment?

Hi Vaibhav, thank your for the query.

The difference you’re observing is expected behaviour and there have been no recent changes to the format.

The schedule.reference field follows the format:

  • Schedule/{serviceId}-{clinicianId} - when slots are associated with a named clinician
  • Schedule/{serviceId} - when slots are not associated with a specific clinician

In the Sandbox environment, the example responses always include a clinician ID (921600556514), which produces the longer format. In the Integration environment, the service you’re querying (6709562) does not have a named clinician on those slots, so only the service ID is included.

Both formats are valid. The Sandbox is a mock and does not represent all possible data variations.

Hope this helps.

George Craft

Hi George,
Thanks for the support, our team will follow the same and if any concerns will connect with you.