5.0.0

The Appointment Search REST APIs provide the capability search for appointment offerings.

See the ApptSearch object for details on how the tenant can specify rules which define how ServiceBroker will search for appointment offerings from the configured Providers, for that tenant.

This API supports operation with the following Providers:

ServiceDispatch
ServiceScheduling

On this page:

Related pages:

Resource URL Summary

Search for Appointment Offerings

POST /up/v5/apptSearch

HTTP Headers

This API uses the standard ServiceBroker HTTP Headers.

API Specifics

Search for Appointment Offerings

This REST API will return the appointment offerings found, based on the tenant's configuration around Providers, search rules, and the provided Appointment Search object.

URL

POST /up/v5/apptSearch

HTTP Request Body

This request requires an Appointment Search object supplied in the HTTP request body.

HTTP Response

Success

On success, an HTTP response code of 200 will be returned, and the response body will contain an Appointment Offer object.

Error

Otherwise, on error, the API will:

Return an HTTP response code of 400, if the request was invalid;
Return an HTTP response code of 401, if the request was not authorized; or
Return an HTTP response code of 500, if something else went wrong.

Both HTTP 400 and 500 responses will contain a REST Integration Standard Response Object with appropriate values for the Code and/or Message fields, describing the error, in the response body.

Browser not supported