Chilkat Online Tools

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

Back to Collection Items

LOCAL loHttp
LOCAL lnSuccess
LOCAL loJson
LOCAL loSbRequestBody
LOCAL loResp

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

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.Http')
loHttp = CreateObject('Chilkat.Http')

* 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"
*   }
* }

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJson = CreateObject('Chilkat.JsonObject')
loJson.UpdateString("criteria.hotelId","{{HotelId}}")
loJson.UpdateString("criteria.reservationIdList[0].id","{{ReservationId}}")
loJson.UpdateString("criteria.reservationIdList[0].type","Reservation")
loJson.UpdateString("criteria.roomId","{{RoomId}}")
loJson.UpdateBool("criteria.overrideInstructions.dirtyRoom",1)
loJson.UpdateBool("criteria.overrideInstructions.outOfServiceRoom",0)
loJson.UpdateBool("criteria.overrideInstructions.sleepDiscrepantRoom",1)
loJson.UpdateBool("criteria.overrideInstructions.occupancyRestriction",0)
loJson.UpdateBool("criteria.overrideInstructions.rateRestriction",0)
loJson.UpdateBool("criteria.overrideInstructions.inventoryRestriction",0)
loJson.UpdateBool("criteria.overrideInstructions.roomNumberLocked",0)
loJson.UpdateBool("criteria.overrideInstructions.holdRoom",0)
loJson.UpdateBool("criteria.overrideInstructions.overrideExternalChecks",0)
loJson.UpdateBool("criteria.overrideInstructions.dayUseReserved",0)
loJson.UpdateBool("criteria.updateRoomTypeCharged",1)
loJson.UpdateBool("criteria.includeDepartureRooms",1)
loJson.UpdateBool("criteria.roomNumberLocked",0)
loJson.UpdateString("criteria.oldRoomStatus","Dirty")
loJson.UpdateString("criteria.reasonCode","NSE")
loJson.UpdateString("criteria.description","Noise Complaint")

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

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.StringBuilder')
loSbRequestBody = CreateObject('Chilkat.StringBuilder')
loJson.EmitSb(loSbRequestBody)

loResp = loHttp.PTextSb("PUT","https://domain.com/fof/v0/hotels/{{HotelId}}/reservations/{{ReservationId}}/rooms/{{RoomId}}/roomMoves",loSbRequestBody,"utf-8","application/json",0,0)
IF (loHttp.LastMethodSuccess = 0) THEN
    ? loHttp.LastErrorText
    RELEASE loHttp
    RELEASE loJson
    RELEASE loSbRequestBody
    CANCEL
ENDIF

? STR(loResp.StatusCode)
? loResp.BodyStr
RELEASE loResp

RELEASE loHttp
RELEASE loJson
RELEASE loSbRequestBody

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