Versions Compared

Key

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

Status
colourGreen
title3.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 areawork center


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 /seiapi/v3/trans/Appointments/OpenSlots

API Specific Parameters

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

Include Page
_Default HTTP Headers
_Default HTTP Headers



API Specifics


_Appointment Search Response Object Formats
Panel
borderColor#D3D3D3

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

Panel
borderColorgrey
bgColorwhitesmoke
borderStylesolid

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

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 Body

The HTTP response body, on success, will contain a Appointment Search Response ObjectOn success, an HTTP response code of 200 will be returned, and the response body will contain open appointment slots in TimeConstraints Object collection. Otherwise, on error, the response body will contain a descriptive reason for the error. 

_Appointment Search Response Object Formats
Code Block
Include Page
languagejs
{
	"TimeConstraints": [
        {
          "Desc": "",
          "Type": "",
          "Period": {
            "Start": "",
            "End": ""
          }
        }
    ]
}