Chilkat Online Tools

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

Back to Collection Items

IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.pb"

Procedure ChilkatExample()

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

    http.i = CkHttp::ckCreate()
    If http.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success.i

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

    json.i = CkJsonObject::ckCreate()
    If json.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckUpdateString(json,"criteria.hotelId","{{HotelId}}")
    CkJsonObject::ckUpdateString(json,"criteria.reservationIdList[0].id","{{ReservationId}}")
    CkJsonObject::ckUpdateString(json,"criteria.reservationIdList[0].type","Reservation")
    CkJsonObject::ckUpdateString(json,"criteria.roomId","{{RoomId}}")
    CkJsonObject::ckUpdateBool(json,"criteria.overrideInstructions.dirtyRoom",1)
    CkJsonObject::ckUpdateBool(json,"criteria.overrideInstructions.outOfServiceRoom",0)
    CkJsonObject::ckUpdateBool(json,"criteria.overrideInstructions.sleepDiscrepantRoom",1)
    CkJsonObject::ckUpdateBool(json,"criteria.overrideInstructions.occupancyRestriction",0)
    CkJsonObject::ckUpdateBool(json,"criteria.overrideInstructions.rateRestriction",0)
    CkJsonObject::ckUpdateBool(json,"criteria.overrideInstructions.inventoryRestriction",0)
    CkJsonObject::ckUpdateBool(json,"criteria.overrideInstructions.roomNumberLocked",0)
    CkJsonObject::ckUpdateBool(json,"criteria.overrideInstructions.holdRoom",0)
    CkJsonObject::ckUpdateBool(json,"criteria.overrideInstructions.overrideExternalChecks",0)
    CkJsonObject::ckUpdateBool(json,"criteria.overrideInstructions.dayUseReserved",0)
    CkJsonObject::ckUpdateBool(json,"criteria.updateRoomTypeCharged",1)
    CkJsonObject::ckUpdateBool(json,"criteria.includeDepartureRooms",1)
    CkJsonObject::ckUpdateBool(json,"criteria.roomNumberLocked",0)
    CkJsonObject::ckUpdateString(json,"criteria.oldRoomStatus","Dirty")
    CkJsonObject::ckUpdateString(json,"criteria.reasonCode","NSE")
    CkJsonObject::ckUpdateString(json,"criteria.description","Noise Complaint")

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

    sbRequestBody.i = CkStringBuilder::ckCreate()
    If sbRequestBody.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckEmitSb(json,sbRequestBody)

    resp.i = CkHttp::ckPTextSb(http,"PUT","https://domain.com/fof/v0/hotels/{{HotelId}}/reservations/{{ReservationId}}/rooms/{{RoomId}}/roomMoves",sbRequestBody,"utf-8","application/json",0,0)
    If CkHttp::ckLastMethodSuccess(http) = 0
        Debug CkHttp::ckLastErrorText(http)
        CkHttp::ckDispose(http)
        CkJsonObject::ckDispose(json)
        CkStringBuilder::ckDispose(sbRequestBody)
        ProcedureReturn
    EndIf

    Debug Str(CkHttpResponse::ckStatusCode(resp))
    Debug CkHttpResponse::ckBodyStr(resp)
    CkHttpResponse::ckDispose(resp)



    CkHttp::ckDispose(http)
    CkJsonObject::ckDispose(json)
    CkStringBuilder::ckDispose(sbRequestBody)


    ProcedureReturn
EndProcedure

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