Chilkat Online Tools

TCL / ORACLE Hospitality OPERA Cloud REST API Workflows / Move an in-house guest to a new room

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.

# {
#   "criteria": {
#     "hotelId": "{{HotelId}}",
#     "reservationIdList": [
#       {
#         "id": "{{ReservationId}}",
#         "type": "Reservation"
#       }
#     ],
#     "roomId": "{{RoomId}}",
#     "overrideInstructions": {
#       "dirtyRoom": true,
#       "outOfServiceRoom": false,
#       "sleepDiscrepantRoom": true,
#       "occupancyRestriction": false,
#       "rateRestriction": false,
#       "inventoryRestriction": false,
#       "roomNumberLocked": false,
#       "holdRoom": false,
#       "overrideExternalChecks": false,
#       "dayUseReserved": false
#     },
#     "updateRoomTypeCharged": true,
#     "includeDepartureRooms": true,
#     "roomNumberLocked": false,
#     "oldRoomStatus": "Dirty",
#     "reasonCode": "NSE",
#     "description": "Noise Complaint"
#   }
# }

set json [new_CkJsonObject]

CkJsonObject_UpdateString $json "criteria.hotelId" "{{HotelId}}"
CkJsonObject_UpdateString $json "criteria.reservationIdList[0].id" "{{ReservationId}}"
CkJsonObject_UpdateString $json "criteria.reservationIdList[0].type" "Reservation"
CkJsonObject_UpdateString $json "criteria.roomId" "{{RoomId}}"
CkJsonObject_UpdateBool $json "criteria.overrideInstructions.dirtyRoom" 1
CkJsonObject_UpdateBool $json "criteria.overrideInstructions.outOfServiceRoom" 0
CkJsonObject_UpdateBool $json "criteria.overrideInstructions.sleepDiscrepantRoom" 1
CkJsonObject_UpdateBool $json "criteria.overrideInstructions.occupancyRestriction" 0
CkJsonObject_UpdateBool $json "criteria.overrideInstructions.rateRestriction" 0
CkJsonObject_UpdateBool $json "criteria.overrideInstructions.inventoryRestriction" 0
CkJsonObject_UpdateBool $json "criteria.overrideInstructions.roomNumberLocked" 0
CkJsonObject_UpdateBool $json "criteria.overrideInstructions.holdRoom" 0
CkJsonObject_UpdateBool $json "criteria.overrideInstructions.overrideExternalChecks" 0
CkJsonObject_UpdateBool $json "criteria.overrideInstructions.dayUseReserved" 0
CkJsonObject_UpdateBool $json "criteria.updateRoomTypeCharged" 1
CkJsonObject_UpdateBool $json "criteria.includeDepartureRooms" 1
CkJsonObject_UpdateBool $json "criteria.roomNumberLocked" 0
CkJsonObject_UpdateString $json "criteria.oldRoomStatus" "Dirty"
CkJsonObject_UpdateString $json "criteria.reasonCode" "NSE"
CkJsonObject_UpdateString $json "criteria.description" "Noise Complaint"

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/fof/v0/hotels/{{HotelId}}/reservations/{{ReservationId}}/rooms/{{RoomId}}/roomMoves" $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 '{
  "criteria": {
    "hotelId": "{{HotelId}}",
    "reservationIdList": [
      {
       "id": "{{ReservationId}}",
        "type": "Reservation"
      }
    ],
    "roomId": "{{RoomId}}",
    "overrideInstructions": {
         "dirtyRoom": true,
            "outOfServiceRoom": false,
            "sleepDiscrepantRoom": true,
            "occupancyRestriction": false,
            "rateRestriction": false,
            "inventoryRestriction": false,
            "roomNumberLocked": false,
            "holdRoom": false,
            "overrideExternalChecks": false,
            "dayUseReserved": false
    },
    "updateRoomTypeCharged": true,
    "includeDepartureRooms": true,
    "roomNumberLocked": false,
    "oldRoomStatus": "Dirty",
   "reasonCode": "NSE",
    "description": "Noise Complaint"
  }
}'
https://domain.com/fof/v0/hotels/{{HotelId}}/reservations/{{ReservationId}}/rooms/{{RoomId}}/roomMoves

Postman Collection Item JSON

{
  "name": "Move an in-house guest to a new room",
  "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",
        "type": "text",
        "value": "{{HotelId}}"
      },
      {
        "key": "x-app-key",
        "type": "text",
        "value": "{{AppKey}}"
      }
    ],
    "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            \"outOfServiceRoom\": false,\r\n            \"sleepDiscrepantRoom\": true,\r\n            \"occupancyRestriction\": false,\r\n            \"rateRestriction\": false,\r\n            \"inventoryRestriction\": false,\r\n            \"roomNumberLocked\": false,\r\n            \"holdRoom\": false,\r\n            \"overrideExternalChecks\": false,\r\n            \"dayUseReserved\": false\r\n    },\r\n    \"updateRoomTypeCharged\": true,\r\n    \"includeDepartureRooms\": true,\r\n    \"roomNumberLocked\": false,\r\n    \"oldRoomStatus\": \"Dirty\",\r\n   \"reasonCode\": \"NSE\",\r\n    \"description\": \"Noise Complaint\"\r\n  }\r\n}",
      "options": {
        "raw": {
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "{{HostName}}/fof/v0/hotels/{{HotelId}}/reservations/{{ReservationId}}/rooms/{{RoomId}}/roomMoves",
      "host": [
        "{{HostName}}"
      ],
      "path": [
        "fof",
        "v0",
        "hotels",
        "{{HotelId}}",
        "reservations",
        "{{ReservationId}}",
        "rooms",
        "{{RoomId}}",
        "roomMoves"
      ]
    },
    "description": "The target room is in the path and the original room is in the body"
  },
  "response": [
  ]
}