Superloop Connect - Appointment-Requests Cancel

Introduction

Cancelling an appointment-request means it can no longer be converted to a booking. Before cancelling an appointment-request you must have created one.

Note: this is NOT cancelling an appointment. It is cancelling the appointment-request.

Request Lifecycle

To cancel the appointment-request, you must send a POST request to /api/connect/orders/appointment-requests/cancel with the body of the request containing the appointment-request id (appointmentRequestId).

Request Specifications

Table 1. API Versions
Version	Header	Changes
1 (Deprecated)	X-API-VERSION=1	Initial Version
2 (Deprecated)	X-API-VERSION=2	No Change
3	X-API-VERSION=3	No Change
4	X-API-VERSION=4	No Change
5	X-API-VERSION=5	No Change
6	X-API-VERSION=6	No Change
7	X-API-VERSION=7	No Change
8	X-API-VERSION=8	No Change

API Version 1, 2, 3, 4, 5, 6, 7 and 8 - POST

POST Request

Table 2. POST Request
Verb	POST
URI	/api/connect/orders/appointment-requests/cancel

Table 3. POST HTTP Request Headers
Name	Description
`Authorization`	The OAuth bearer access token
`X-API-VERSION`	The version of the endpoint you are accessing

Table 4. POST Request Body Fields
Path	Type	Description	Required
`appointmentRequestId`	`Number`	The id of the appointment-request to cancel	Required

POST Response

Table 5. POST HTTP Status Codes
Status Code	Meaning
204	The request was completed successfully
401	Bearer Token missing or invalid
404	You are not authorised or The id (of the appointment-request) provided does not exist
500	There was an unexpected error processing the request

API Version 1, 2, 3, 4, 5, 6, 7 and 8 - Examples

Appointment Cancelled

A request to cancel an appointment-request is created by sending a request JSON object as a POST request to /api/connect/orders/appointment-requests/cancel.

POST Request

POST /api/connect/orders/appointment-requests/cancel HTTP/1.1
Content-Type: application/json;charset=UTF-8
Authorization: Bearer eyJraWQiOiJ1X25vaWhzY21YU2Jja1hBeHVvcEM0U2VENWxGNjhOb1dxTnMwWlVUV2RBIiwiYWxnIjoiUlMyNTYifQ.eyJzdWIiOiJjYTBjZTY2YS00MDhjLTRiM2EtYWE3My0xMTliNDkyMzQ2YmMiLCJjbGllbnRJZCI6InBvcnRhbC1hcGkiLCJjbGllbnRIb3N0IjoibG9jYWxob3N0IiwiaXNzIjoiaHR0cDpcL1wvbG9jYWxob3N0OjEwMTk5XC9hdXRoXC9yZWFsbXNcL3N1cGVybG9vcCIsInR5cCI6IkJlYXJlciIsInVzZXJJZCI6IjExMDAxIiwiY2xpZW50QWRkcmVzcyI6IjEyNy4wLjAuMSIsImF6cCI6InBvcnRhbC1hcGkiLCJleHAiOjE3NjE3MTQxNTEsImlhdCI6MTc2MTcxMDU1MSwianRpIjoiNWIwNzRlYTItNzgyMC00NDQwLWJjNzItMjA5ZDJiZTgzOTE3IiwiYXBwcyI6InBvcnRhbC1hcGkifQ.MM7-XvSPB_0lzni2DlQmoCFsAc7u_kjO0-Rt53JMoV7dns0LdtAXJen7ThKG__lPX8b463CnmRFrvFTt9wXRbJYoTqzL86cF7LZJPMsuHzBh4f90IyUSpwgejDnMRc7SJnQPKHIzl2aTSenM-mHGfGUkWOOmDkcEwD32x1-x21vd0J_xGDmd5doo1zwqbT_maO3qn18w-oWaHawuHH9Rp1jjNKS6xRlwJt7TKyg65yW4mRXvacDzfW28AAbcLaZlgKMGw83nIXc78KiHHIXyGcnTZQvBTWHSUu8q-3tlFDcUDdKUMFMMje3nUQ-ohgN4HLTHtxTVt8frS0uoOHAW7g
X-API-VERSION: 8
Content-Length: 28
Host: localhost:8080

{"appointmentRequestId":300}

If all required fields were given, then the response to the request will have:

a http status of 204

Successful POST Response

HTTP/1.1 204 No Content
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY