Chilkat Online Tools

Ruby / ORACLE Hospitality OPERA Cloud REST API Workflows / 14. Check-Out - putReservation (add departure time)

Back to Collection Items

require 'chilkat'

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

http = Chilkat::CkHttp.new()

# 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}}"
#         }
#       ],
#       "roomStay": {
#         "arrivalDate": "2021-03-23",
#         "departureDate": "2021-03-23",
#         "expectedTimes": {
#           "reservationExpectedArrivalTime": "2021-03-23 13:00:00.0",
#           "reservationExpectedDepartureTime": "2021-03-23 10:00:00.0"
#         }
#       },
#       "hotelId": "{{HotelId}}",
#       "customReference": "",
#       "preRegistered": false,
#       "allowMobileCheckout": false
#     }
#   ]
# }

json = Chilkat::CkJsonObject.new()
json.UpdateString("reservations[0].reservationIdList[0].type","Reservation")
json.UpdateString("reservations[0].reservationIdList[0].id","{{ReservationId}}")
json.UpdateString("reservations[0].roomStay.arrivalDate","2021-03-23")
json.UpdateString("reservations[0].roomStay.departureDate","2021-03-23")
json.UpdateString("reservations[0].roomStay.expectedTimes.reservationExpectedArrivalTime","2021-03-23 13:00:00.0")
json.UpdateString("reservations[0].roomStay.expectedTimes.reservationExpectedDepartureTime","2021-03-23 10:00:00.0")
json.UpdateString("reservations[0].hotelId","{{HotelId}}")
json.UpdateString("reservations[0].customReference","")
json.UpdateBool("reservations[0].preRegistered",false)
json.UpdateBool("reservations[0].allowMobileCheckout",false)

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

sbRequestBody = Chilkat::CkStringBuilder.new()
json.EmitSb(sbRequestBody)

# resp is a CkHttpResponse
resp = http.PTextSb("PUT","https://domain.com/rsv/v1/hotels/{{HotelId}}/reservations/{{ReservationId}}",sbRequestBody,"utf-8","application/json",false,false)
if (http.get_LastMethodSuccess() == false)
    print http.lastErrorText() + "\n";
    exit
end

print resp.get_StatusCode().to_s() + "\n";
print resp.bodyStr() + "\n";

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}}"
                }
            ],
            "roomStay": {
                "arrivalDate": "2021-03-23",
                "departureDate": "2021-03-23",
                "expectedTimes": {
                    "reservationExpectedArrivalTime": "2021-03-23 13:00:00.0",
                    "reservationExpectedDepartureTime": "2021-03-23 10:00:00.0"
                }
            },
            "hotelId": "{{HotelId}}",
            "customReference": "",
            "preRegistered": false,
            "allowMobileCheckout": false
        }
    ]
}'
https://domain.com/rsv/v1/hotels/{{HotelId}}/reservations/{{ReservationId}}

Postman Collection Item JSON

{
  "name": "14. Check-Out - putReservation (add departure time)",
  "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            \"roomStay\": {\r\n                \"arrivalDate\": \"2021-03-23\",\r\n                \"departureDate\": \"2021-03-23\",\r\n                \"expectedTimes\": {\r\n                    \"reservationExpectedArrivalTime\": \"2021-03-23 13:00:00.0\",\r\n                    \"reservationExpectedDepartureTime\": \"2021-03-23 10:00:00.0\"\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": "A reservation must have $0 balance, and be in 'Due-out' status to be able to check out."
  },
  "response": [
  ]
}