Versions Compared

Version Old Version 20 New Version Current
Changes made by

Jason Andrew

Jason Andrew

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Published by Scroll Versions from space SBUD and version 5

Status
colourGreen
title5.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.

Info

This API supports operation with the following Providers:

  • ServiceDispatch 
  • ServiceScheduling
Panel
borderColorgrey
bgColorwhitesmoke
borderStylesolid

On this page:

Table of Contents
maxLevel2

Related pages:

Resource URL Summary

Panel
borderColorgrey
bgColorwhitesmoke
borderStylesolid

Search for Appointment Offerings

POST /up/v5/apptSearch

Include Page
_Default HTTP Headers
_Default HTTP Headers

API Specifics

Panel
borderColor#D3D3D3

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

Panel
borderColorgrey
bgColorwhitesmoke
borderStylesolid

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

Include Page
_Default Response
_Default Response