Versions Compared

Old Version 70

changes.mady.by.user Mickey Bushman

Saved on

compared with

New Version Current

changes.mady.by.user Jason Andrew

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Status
colourGreen
title3.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 REST Standard REST APIs Appointment Search REST API are passed through to their system.

(info) The Appointment Search REST API Interface is a critical part of allowing customers to use the REST Standard REST APIs 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 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.

Note

Before the Appointment Search REST API can be used for a given entity, it will be necessary to use the REST Configuration REST APIs 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.



Panel
borderColorgrey
bgColorwhitesmoke
borderStylesolid

On this page:

Table of Contents
maxLevel2

Related pages:


Resource URL Summary

Panel
borderColorgrey
bgColorwhitesmoke
borderStylesolid

Retrieve the details of open appointment slots

POST <REST Endpoint URI>

Include Page
_Default HTTP Headers for Interfaces
_Default HTTP Headers for Interfaces

API Specifics


Panel
borderColor#D3D3D3

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

Panel
borderColorgrey
bgColorwhitesmoke
borderStylesolid

POST <REST Endpoint URI>

HTTP Request Body

The HTTP request body must contain a valid Appointment Search Object. 

Insert excerpt
REST Object Definitions Work Order Activity Related Objects Appointment Search ObjectREST Object Definitions Work Order Activity Related Objects
Appointment Search Object
nopaneltrue

HTTP Response

Response Codes

HTTP CodeDescription
200OK. The IVR message was sent successfully.
401Invalid Logon.
500Server 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 REST Standard REST APIs Appointment Search REST API.

ServiceMobility will return the response code (and response body, if present) as the response to the initiating REST Standard REST APIs Appointment Search REST API call.