Chilkat Online Tools

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

Back to Collection Items

import sys
import chilkat2

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

http = chilkat2.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
# }

json = chilkat2.JsonObject()
json.UpdateString("reason.description","Trip Cancelled")
json.UpdateString("reason.code","CXL")
json.UpdateString("reservations[0].reservationIdList[0].id","{{ReservationId}}")
json.UpdateString("reservations[0].reservationIdList[0].type","Reservation")
json.UpdateString("reservations[0].roomStatus","Inspected")
json.UpdateString("reservations[0].allowedActions[0]","Cancel")
json.UpdateString("reservations[0].hotelId","{{HotelId}}")
json.UpdateBool("reservations[0].cxlInstr.deleteResTraces",False)
json.UpdateBool("verificationOnly",True)

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

# resp is a CkHttpResponse
resp = http.PostJson3("https://domain.com/rsv/v1/hotels/{{HotelId}}/reservations/{{ReservationId}}/cancellations","application/json",json)
if (http.LastMethodSuccess == False):
    print(http.LastErrorText)
    sys.exit()

print(str(resp.StatusCode))
print(resp.BodyStr)

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": [
  ]
}