Schedule Optimization > Resources > Schedule Optimization APIs > Appointment Booking APIs > getAppointmentResponse
getAppointmentResponse
Description
This is the response for the getAppointmentRequest that has been passed. The Ranked Appointment Booking page is displayed in the UI.
Example
The following is an example getAppointmentResponse JSON file.
{
"dispatchProcessId": "a18g0000008M1icAAC",
"territoryId": "a1jg000000226nIAAQ",
"orgId": "00Dg0000006Qv56",
"workOrderId": "WO-00008580",
"appointmentOffers": [
{
"startDateTime": "2028-09-12 14:00",
"endDateTime": "2028-09-12 15:00",
"slotCategory": "RECOMMENDED"
},
{
"startDateTime": "2028-09-12 07:00",
"endDateTime": "2028-09-12 08:00",
"slotCategory": "RECOMMENDED"
},
{
"startDateTime": "2028-09-12 10:00",
"endDateTime": "2028-09-12 11:00",
"slotCategory": "RECOMMENDED"
},
{
"startDateTime": "2028-09-12 11:00",
"endDateTime": "2028-09-12 12:00",
"slotCategory": "RECOMMENDED"
},
{
"startDateTime": "2028-09-12 09:00",
"endDateTime": "2028-09-12 10:00",
"slotCategory": "RECOMMENDED"
},
{
"startDateTime": "2028-09-12 08:00",
"endDateTime": "2028-09-12 09:00",
"slotCategory": "RECOMMENDED"
},
{
"startDateTime": "2028-09-12 12:00",
"endDateTime": "2028-09-12 13:00",
"slotCategory": "OK"
},
{
"startDateTime": "2028-09-12 13:00",
"endDateTime": "2028-09-12 14:00",
"slotCategory": "RECOMMENDED"
}
],
"statusCode": 0,
"errorMessage": "Success",
"jobInstanceId": 0,
"requestExpirationTime": 1591694081454
}
Field Descriptions
The following table describes the fields in the getAppointmentResponse JSON. See the sample response file for examples.
Field
Description
Notes
dispatchProcessId
This is the dispatch process ID.
territoryId
This is the territory ID.
orgId
This is the Salesforce org ID.
workOrderId
This is the work order number.
appointmentOffers
This field contains the available appointment slots for the work order.
These are provided in the pairs of startDateTime, endDateTime, and slotCategory field values.
The slotCategory value indicates whether the slot is Recommended, OK, or Poor slot.
statusCode
This is the code indicating the status of the request.
errorMessage
This is the status message text.
jobInstanceId
This is the job reference ID.
requestExpirationTime
This is the request expiry time duration.
Was this helpful?