Chilkat Online Tools

Ruby / ORACLE Hospitality OPERA Cloud REST API Workflows / 07. Pre-Arrival - postRoomAssignment

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.

# {
#   "criteria": {
#     "hotelId": "{{HotelId}}",
#     "reservationIdList": [
#       {
#         "id": "{{ReservationId}}",
#         "type": "Reservation"
#       }
#     ],
#     "roomId": "{{RoomId}}",
#     "overrideInstructions": {
#       "dirtyRoom": true
#     },
#     "updateRoomTypeCharged": true,
#     "includeDepartureRooms": true,
#     "roomNumberLocked": true
#   }
# }

json = Chilkat::CkJsonObject.new()
json.UpdateString("criteria.hotelId","{{HotelId}}")
json.UpdateString("criteria.reservationIdList[0].id","{{ReservationId}}")
json.UpdateString("criteria.reservationIdList[0].type","Reservation")
json.UpdateString("criteria.roomId","{{RoomId}}")
json.UpdateBool("criteria.overrideInstructions.dirtyRoom",true)
json.UpdateBool("criteria.updateRoomTypeCharged",true)
json.UpdateBool("criteria.includeDepartureRooms",true)
json.UpdateBool("criteria.roomNumberLocked",true)

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

# resp is a CkHttpResponse
resp = http.PostJson3("https://domain.com/fof/v0/hotels/{{HotelId}}/reservations/{{ReservationId}}/roomAssignments","application/json",json)
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 POST
	-H "Authorization: Bearer <access_token>"
	-H "Content-Type: application/json"
	-H "x-app-key: {{AppKey}}"
	-H "x-hotelid: {{HotelId}}"
	-d '{
    "criteria": {
        "hotelId": "{{HotelId}}",
        "reservationIdList": [
            {
                "id": "{{ReservationId}}",
                "type": "Reservation"
            }
        ],
        "roomId": "{{RoomId}}",
        "overrideInstructions": {
            "dirtyRoom": true
        },
        "updateRoomTypeCharged": true,
        "includeDepartureRooms": true,
        "roomNumberLocked": true
    }
}'
https://domain.com/fof/v0/hotels/{{HotelId}}/reservations/{{ReservationId}}/roomAssignments

Postman Collection Item JSON

{
  "name": "07. Pre-Arrival - postRoomAssignment",
  "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    \"criteria\": {\r\n        \"hotelId\": \"{{HotelId}}\",\r\n        \"reservationIdList\": [\r\n            {\r\n                \"id\": \"{{ReservationId}}\",\r\n                \"type\": \"Reservation\"\r\n            }\r\n        ],\r\n        \"roomId\": \"{{RoomId}}\",\r\n        \"overrideInstructions\": {\r\n            \"dirtyRoom\": true\r\n        },\r\n        \"updateRoomTypeCharged\": true,\r\n        \"includeDepartureRooms\": true,\r\n        \"roomNumberLocked\": true\r\n    }\r\n}",
      "options": {
        "raw": {
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "{{HostName}}/fof/v0/hotels/{{HotelId}}/reservations/{{ReservationId}}/roomAssignments",
      "host": [
        "{{HostName}}"
      ],
      "path": [
        "fof",
        "v0",
        "hotels",
        "{{HotelId}}",
        "reservations",
        "{{ReservationId}}",
        "roomAssignments"
      ]
    },
    "description": "Use this API to add/assign a room number to a guests reservation. This is required before they can check into the property."
  },
  "response": [
  ]
}