Chilkat Online Tools

Foxpro / ORACLE Hospitality OPERA Cloud REST API Workflows / Cancel a reservation

Back to Collection Items

LOCAL loHttp
LOCAL lnSuccess
LOCAL loJson
LOCAL loResp

* This example assumes the Chilkat API to have been previously unlocked.
* See Global Unlock Sample for sample code.

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.Http')
loHttp = CreateObject('Chilkat.Http')

* Use this online tool to generate code from sample JSON: Generate Code to Create JSON

* The following JSON is sent in the request body.

* {
*   "reason": {
*     "description": "Trip Cancelled",
*     "code": "CXL"
*   },
*   "reservations": [
*     {
*       "reservationIdList": [
*         {
*           "id": "{{ReservationId}}",
*           "type": "Reservation"
*         }
*       ],
*       "roomStatus": "Inspected",
*       "allowedActions": [
*         "Cancel"
*       ],
*       "hotelId": "{{HotelId}}",
*       "cxlInstr": {
*         "deleteResTraces": false
*       }
*     }
*   ],
*   "verificationOnly": true
* }

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJson = CreateObject('Chilkat.JsonObject')
loJson.UpdateString("reason.description","Trip Cancelled")
loJson.UpdateString("reason.code","CXL")
loJson.UpdateString("reservations[0].reservationIdList[0].id","{{ReservationId}}")
loJson.UpdateString("reservations[0].reservationIdList[0].type","Reservation")
loJson.UpdateString("reservations[0].roomStatus","Inspected")
loJson.UpdateString("reservations[0].allowedActions[0]","Cancel")
loJson.UpdateString("reservations[0].hotelId","{{HotelId}}")
loJson.UpdateBool("reservations[0].cxlInstr.deleteResTraces",0)
loJson.UpdateBool("verificationOnly",1)

loHttp.SetRequestHeader("Content-Type","application/json")
loHttp.SetRequestHeader("x-app-key","{{AppKey}}")
* Adds the "Authorization: Bearer <access_token>" header.
loHttp.AuthToken = "<access_token>"
loHttp.SetRequestHeader("x-hotelId","{{HotelId}}")

loResp = loHttp.PostJson3("https://domain.com/rsv/v1/hotels/{{HotelId}}/reservations/{{ReservationId}}/cancellations","application/json",loJson)
IF (loHttp.LastMethodSuccess = 0) THEN
    ? loHttp.LastErrorText
    RELEASE loHttp
    RELEASE loJson
    CANCEL
ENDIF

? STR(loResp.StatusCode)
? loResp.BodyStr
RELEASE loResp

RELEASE loHttp
RELEASE loJson

Curl Command

curl -X POST
	-H "Authorization: Bearer <access_token>"
	-H "Content-Type: application/json"
	-H "x-app-key: {{AppKey}}"
	-H "x-hotelId: {{HotelId}}"
	-d '{
  "reason": {
    "description": "Trip Cancelled",
    "code": "CXL"
  },
  "reservations": [
    {
      "reservationIdList": [
        {
          "id": "{{ReservationId}}",
          "type": "Reservation"
        }
      ],
      "roomStatus": "Inspected",
      "allowedActions": [
        "Cancel"
      ],
      "hotelId": "{{HotelId}}",
      "cxlInstr": {
        "deleteResTraces": false
      }
    }
  ],
  "verificationOnly": true
}'
https://domain.com/rsv/v1/hotels/{{HotelId}}/reservations/{{ReservationId}}/cancellations

Postman Collection Item JSON

{
  "name": "Cancel a reservation",
  "request": {
    "auth": {
      "type": "bearer",
      "bearer": [
        {
          "key": "token",
          "value": "{{Token}}",
          "type": "string"
        }
      ]
    },
    "method": "POST",
    "header": [
      {
        "key": "Content-Type",
        "name": "Content-Type",
        "type": "text",
        "value": "application/json"
      },
      {
        "key": "x-app-key",
        "type": "text",
        "value": "{{AppKey}}"
      },
      {
        "key": "x-hotelId",
        "type": "text",
        "value": "{{HotelId}}"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\r\n  \"reason\": {\r\n    \"description\": \"Trip Cancelled\",\r\n    \"code\": \"CXL\"\r\n  },\r\n  \"reservations\": [\r\n    {\r\n      \"reservationIdList\": [\r\n        {\r\n          \"id\": \"{{ReservationId}}\",\r\n          \"type\": \"Reservation\"\r\n        }\r\n      ],\r\n      \"roomStatus\": \"Inspected\",\r\n      \"allowedActions\": [\r\n        \"Cancel\"\r\n      ],\r\n      \"hotelId\": \"{{HotelId}}\",\r\n      \"cxlInstr\": {\r\n        \"deleteResTraces\": false\r\n      }\r\n    }\r\n  ],\r\n  \"verificationOnly\": true\r\n}",
      "options": {
        "raw": {
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "{{HostName}}/rsv/v1/hotels/{{HotelId}}/reservations/{{ReservationId}}/cancellations",
      "host": [
        "{{HostName}}"
      ],
      "path": [
        "rsv",
        "v1",
        "hotels",
        "{{HotelId}}",
        "reservations",
        "{{ReservationId}}",
        "cancellations"
      ]
    },
    "description": "To cancel a reservaiton in OPERA Cloud."
  },
  "response": [
  ]
}