3.18.0
The Appointment Search REST API Interface defines the REST API interface which customers will need to implement if they would like ServiceMobility to search open appointment slots for a specific account location via their own systems.
By implementing an API which matches the Appointment Search REST API Interface, customers can configure ServiceMobility (via the Entity System Configuration object) so that requests to search open appointment slots for a specific account location via the Appointment Search REST API are passed through to their system.
The Appointment Search REST API Interface is a critical part of allowing customers to use the Book Job REST API to book a follow-up work order via their own systems - in order to book a follow-up work order in their own systems (via the REST Interfaces Followup WorkOrder REST API Interface), it is first necessary to search their own systems for a open appointment slots, so that a slot can be selected, and then booked.
Before the Appointment Search REST API can be used for a given entity, it will be necessary to use the Entity System Configuration REST API to update the entity's REST Object Definitions Configuration Related Objects Entity System Configuration Object and configure the RestApi.SearchAppts property, to define the REST Endpoint URI of an API that implements the REST Interfaces Appointment Search REST API Interface.
On this page:
Related pages:
Resource URL Summary
Retrieve the details of open appointment slots
POST <REST Endpoint URI>
HTTP Headers
ServiceMobility will set both of the Standard HTTP Headers when calling this REST API Interface.
That is:
- The
Content-Typeheader will be set toapplication/json; and - The
x-access-tokenheader will be set to the JWT that was used in the call to the API that triggered ServiceMobility to call the configured endpoint that implements this interface.
The x-access-token header will either be the JWT issued by ServiceMobility, or by the endpoint that implements the Authentication REST API Interface that ServiceMobility has been configured to use.
Implementations of this interface may evaluate the JWT supplied, if required, but please note that ServiceMobility will have already authenticated the JWT in the initial API call before passing the call on to the configured endpoint.
API Specifics
Retrieve the details of open appointment slots
This REST API must return the details of open Appointment slots, based on the specified Appointment Search Object.
URL
POST <REST Endpoint URI>
HTTP Request Body
The HTTP request body must contain a valid Appointment Search Object.
HTTP Response
Response Codes
| HTTP Code | Description |
|---|---|
| 200 | OK. The IVR message was sent successfully. |
| 401 | Invalid Logon. |
| 500 | Server error. An error occurred while processing the request. The HTTP response body should have more details as to the possible cause. |
On success, an HTTP response code of 200 must be returned, and the response body must contain a valid response body that is the same as would be returned from the Appointment Search REST API.
ServiceMobility will return the response code (and response body, if present) as the response to the initiating Appointment Search REST API call.