Chilkat Online Tools

TCL / ORACLE Hospitality OPERA Cloud REST API Workflows / 05. Pre-Arrival - putReservation (add pref)

Back to Collection Items

load ./chilkat.dll

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

set http [new_CkHttp]

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

# The following JSON is sent in the request body.

# {
#   "reservations": [
#     {
#       "reservationIdList": [
#         {
#           "type": "Reservation",
#           "id": "{{ReservationId}}"
#         }
#       ],
#       "preferenceCollection": [
#         {
#           "preference": [
#             {
#               "preferenceValue": "AWAY",
#               "hotels": "{{HotelId}}",
#               "global": false
#             }
#           ],
#           "preferenceType": "ROOM FEATURES"
#         }
#       ],
#       "hotelId": "{{HotelId}}",
#       "customReference": "",
#       "preRegistered": false,
#       "allowMobileCheckout": false
#     }
#   ]
# }

set json [new_CkJsonObject]

CkJsonObject_UpdateString $json "reservations[0].reservationIdList[0].type" "Reservation"
CkJsonObject_UpdateString $json "reservations[0].reservationIdList[0].id" "{{ReservationId}}"
CkJsonObject_UpdateString $json "reservations[0].preferenceCollection[0].preference[0].preferenceValue" "AWAY"
CkJsonObject_UpdateString $json "reservations[0].preferenceCollection[0].preference[0].hotels" "{{HotelId}}"
CkJsonObject_UpdateBool $json "reservations[0].preferenceCollection[0].preference[0].global" 0
CkJsonObject_UpdateString $json "reservations[0].preferenceCollection[0].preferenceType" "ROOM FEATURES"
CkJsonObject_UpdateString $json "reservations[0].hotelId" "{{HotelId}}"
CkJsonObject_UpdateString $json "reservations[0].customReference" ""
CkJsonObject_UpdateBool $json "reservations[0].preRegistered" 0
CkJsonObject_UpdateBool $json "reservations[0].allowMobileCheckout" 0

CkHttp_SetRequestHeader $http "Content-Type" "application/json"
CkHttp_SetRequestHeader $http "x-hotelid" "{{HotelId}}"
# Adds the "Authorization: Bearer <access_token>" header.
CkHttp_put_AuthToken $http "<access_token>"
CkHttp_SetRequestHeader $http "x-app-key" "{{AppKey}}"

set sbRequestBody [new_CkStringBuilder]

CkJsonObject_EmitSb $json $sbRequestBody

# resp is a CkHttpResponse
set resp [CkHttp_PTextSb $http "PUT" "https://domain.com/rsv/v1/hotels/{{HotelId}}/reservations/{{ReservationId}}" $sbRequestBody "utf-8" "application/json" 0 0]
if {[CkHttp_get_LastMethodSuccess $http] == 0} then {
    puts [CkHttp_lastErrorText $http]
    delete_CkHttp $http
    delete_CkJsonObject $json
    delete_CkStringBuilder $sbRequestBody
    exit
}

puts [CkHttpResponse_get_StatusCode $resp]
puts [CkHttpResponse_bodyStr $resp]
delete_CkHttpResponse $resp


delete_CkHttp $http
delete_CkJsonObject $json
delete_CkStringBuilder $sbRequestBody

Curl Command

curl -X PUT
	-H "Authorization: Bearer <access_token>"
	-H "Content-Type: application/json"
	-H "x-hotelid: {{HotelId}}"
	-H "x-app-key: {{AppKey}}"
	-d '{
    "reservations": [
        {
            "reservationIdList": [
                {
                    "type": "Reservation",
                    "id": "{{ReservationId}}"
                }
            ],
            "preferenceCollection": [
                {
                    "preference": [
                        {
                            "preferenceValue": "AWAY",
                            "hotels": "{{HotelId}}",
                            "global": false
                        }
                    ],
                    "preferenceType": "ROOM FEATURES"
                }
            ],
            "hotelId": "{{HotelId}}",
            "customReference": "",
            "preRegistered": false,
            "allowMobileCheckout": false
        }
    ]
}'
https://domain.com/rsv/v1/hotels/{{HotelId}}/reservations/{{ReservationId}}

Postman Collection Item JSON

{
  "name": "05. Pre-Arrival - putReservation (add pref)",
  "request": {
    "auth": {
      "type": "bearer",
      "bearer": [
        {
          "key": "token",
          "value": "{{Token}}",
          "type": "string"
        }
      ]
    },
    "method": "PUT",
    "header": [
      {
        "key": "Content-Type",
        "name": "Content-Type",
        "type": "text",
        "value": "application/json"
      },
      {
        "key": "x-hotelid",
        "value": "{{HotelId}}",
        "type": "text"
      },
      {
        "key": "x-app-key",
        "value": "{{AppKey}}",
        "type": "text"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\r\n    \"reservations\": [\r\n        {\r\n            \"reservationIdList\": [\r\n                {\r\n                    \"type\": \"Reservation\",\r\n                    \"id\": \"{{ReservationId}}\"\r\n                }\r\n            ],\r\n            \"preferenceCollection\": [\r\n                {\r\n                    \"preference\": [\r\n                        {\r\n                            \"preferenceValue\": \"AWAY\",\r\n                            \"hotels\": \"{{HotelId}}\",\r\n                            \"global\": false\r\n                        }\r\n                    ],\r\n                    \"preferenceType\": \"ROOM FEATURES\"\r\n                }\r\n            ],\r\n            \"hotelId\": \"{{HotelId}}\",\r\n            \"customReference\": \"\",\r\n            \"preRegistered\": false,\r\n            \"allowMobileCheckout\": false\r\n        }\r\n    ]\r\n}",
      "options": {
        "raw": {
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "{{HostName}}/rsv/v1/hotels/{{HotelId}}/reservations/{{ReservationId}}",
      "host": [
        "{{HostName}}"
      ],
      "path": [
        "rsv",
        "v1",
        "hotels",
        "{{HotelId}}",
        "reservations",
        "{{ReservationId}}"
      ]
    },
    "description": "To update an existing reservation in OPERA by attaching Preferences."
  },
  "response": [
  ]
}