Versions Compared

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 Book REST APIs provide the capability to book an appointment offering (i.e. create a Work Item), where the appointment offering has been obtained by using the REST Work Item Appointment Search.    

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

Book an Appointment Offering

POST /up/v5/apptBook  

Include Page
_Default HTTP Headers
_Default HTTP Headers


API Specifics

Panel
borderColor#D3D3D3

Book an Appointment Offering

This REST API accepts an Appointment Book Request object, which has been created using the details of an appointment offering obtained by using the REST Work Item Appointment Search. On success, the REST API will create a Work Item object based on the details supplied.

URL

Panel
borderColorgrey
bgColorwhitesmoke
borderStylesolid

POST /up/v5/apptBook

HTTP Request Body

This request requires an Appointment Book Request object supplied in the HTTP request body.

HTTP Response

On both success and error, the REST API returns the default response.

If the REST API was successful, the a Work Item object will have been created. (Note that the Id of the Work Item is a required part of the Appointment Book Request object, so the created Work Item object can be managed via the REST Work Item APIs using this Id value.)

If the REST API was not successful, then the details will be in the default response.

Include Page
_Default Response
_Default Response