Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 13 Current »

3.18.0

The Appointment Search REST API is used to search open appointment slots for a specific account location. The REST API acts as a proxy to the customer's CRM system to query open appointment slots. The response body will contain a list of open appointment slots for mobile worker(s) within a specific service area. 

On this page:

Related pages:

Resource URL Summary

Retrieve the details of open appointment slots

POST /seiapi/v3/trans/Appointments/OpenSlots

API Specific Parameters

There are no API specific parameters for the Appointment Search REST API.

HTTP Headers

This API uses the default ServiceMobility HTTP Headers.


API Specifics

Retrieve the details of open appointment slots

This REST API will return the details of open Appointment slots, based on the specified REST Object Definitions Work Order Activity Related Objects Appointment Search Object.

URL

POST /seiapi/v3/trans/Appointments/OpenSlots

HTTP Request Body

The HTTP request body must contain a valid REST Object Definitions Work Order Activity Related Objects Appointment Search Object. 

Error rendering macro 'excerpt-include' : No link could be created for 'REST Object Definitions Work Order Activity Related Objects Appointment Search Object'.

HTTP Response Body

The HTTP response body, on success, will contain a Appointment Search Response Object. Otherwise, on error, the response body will contain a descriptive reason for the error. 

JSON Format 
{
	"StatusMsg": "",
    "TimeConstraints": [
        {
          "Desc": "",
          "Type": "",
          "Period": {
            "Start": "",
            "End": ""
          }
        }
    ]
}

  • No labels