TABLE OF CONTENTS

Cancel Call Request Schema

This endpoint allows your system to submit a cancellation request for a previously created call request. By doing so, you indicate that DerbySoft should no longer attempt to contact the hotel on your behalf. To successfully cancel a call request:

  • The check-in date must not be in the past.
  • The call request’s status must not be Completed or being currently progress.
  • Requests that are already completed or actively being processed cannot be canceled
Request (METHOD: POST)
LevelField NameNum.Occ.DataTypeFormatDescriptionExample
1CallRequested1String16 Char

Unique identifier for a call request provided by Derbysoft when the call request was submitted.

66a1b2c3d4e5f678


Cancel Call Request Example

Call request cancellation RQ

{
  "callRequestId": "77b2c4d5e6f7g890"
}


Cancel Call Request Response Schema

When a cancellation request is submitted, DerbySoft will return a response indicating whether the operation was successful.

  • If the cancellation is successful, the response will:
    • Include a confirmation message.
    • Provide a timestamp indicating when the call request was canceled.
  • If the cancellation fails (e.g., due to invalid status or check-in constraints), the response will:
    • Indicate that the call request could not be canceled.
    • Indicating a reason or error message explaining why the cancellation was rejected.



HTTP Response
LevelField Name
Num.Occ.DataTypeFormaTDescriptionExample
1success1booleanTrue
False

True: call request was successfully retrieve

False: call request cannot be retrieve

TRUE
1result0...1object36 Char
Universal Unique Identifier. Number used to uniquely identify.bc8f34aO-d6d8-4575-a70a-f78453761214
2callRequstId1String16 CharUnique identifier for a call request provided by Derbysoft when the call request was submitted.66a1b2c3d4e5f678
2cancelled_at1date-timeYYYY-MM-DDTHH:MM:SSZTimestamp of when cancellation was processed under full ISO 8601 UTC 2025-04-22T14:30:00Z
1error
0...1object

-

Object used for error description-
2code0...1string100
Short error description

 BAD_REQUEST

2message0...1string500
Long error description

"Invalid request: call type cannot be empty"



Cancel Call Request Response Example

Call request cancellation Success RS

{
  "success": true,
  "results": {
      "callRequestId": "77b2c4d5e6f7g890",
      "cancelled_at": "2025-06-03T09:31:00Z"
}

Call request cancellation Error RS

{
  "success": false,
  "error": { 
    "code": "CANCELLATION_NOT_ALLOWED", 
    "message": "Call request cannot be cancelled as check in is in the past." 
  }
}