Chilkat Online Tools

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

Back to Collection Items

func chilkatTest() {
    // This example assumes the Chilkat API to have been previously unlocked.
    // See Global Unlock Sample for sample code.

    let http = CkoHttp()!
    var success: Bool

    // 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
    // }

    let json = CkoJsonObject()!
    json.update("reason.description", value: "Trip Cancelled")
    json.update("reason.code", value: "CXL")
    json.update("reservations[0].reservationIdList[0].id", value: "{{ReservationId}}")
    json.update("reservations[0].reservationIdList[0].type", value: "Reservation")
    json.update("reservations[0].roomStatus", value: "Inspected")
    json.update("reservations[0].allowedActions[0]", value: "Cancel")
    json.update("reservations[0].hotelId", value: "{{HotelId}}")
    json.updateBool("reservations[0].cxlInstr.deleteResTraces", value: false)
    json.updateBool("verificationOnly", value: true)

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

    var resp: CkoHttpResponse? = http.postJson3("https://domain.com/rsv/v1/hotels/{{HotelId}}/reservations/{{ReservationId}}/cancellations", contentType: "application/json", json: json)
    if http.lastMethodSuccess == false {
        print("\(http.lastErrorText!)")
        return
    }

    print("\(resp!.statusCode.intValue)")
    print("\(resp!.bodyStr!)")
    resp = nil

}

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