Chilkat Online Tools

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

Back to Collection Items

#import <CkoHttp.h>
#import <CkoJsonObject.h>
#import <CkoStringBuilder.h>
#import <CkoHttpResponse.h>

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

CkoHttp *http = [[CkoHttp alloc] init];
BOOL success;

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

CkoJsonObject *json = [[CkoJsonObject alloc] init];
[json UpdateString: @"criteria.hotelId" value: @"{{HotelId}}"];
[json UpdateString: @"criteria.reservationIdList[0].id" value: @"{{ReservationId}}"];
[json UpdateString: @"criteria.reservationIdList[0].type" value: @"Reservation"];
[json UpdateString: @"criteria.roomId" value: @"{{RoomId}}"];
[json UpdateBool: @"criteria.overrideInstructions.dirtyRoom" value: YES];
[json UpdateBool: @"criteria.overrideInstructions.outOfServiceRoom" value: NO];
[json UpdateBool: @"criteria.overrideInstructions.sleepDiscrepantRoom" value: YES];
[json UpdateBool: @"criteria.overrideInstructions.occupancyRestriction" value: NO];
[json UpdateBool: @"criteria.overrideInstructions.rateRestriction" value: NO];
[json UpdateBool: @"criteria.overrideInstructions.inventoryRestriction" value: NO];
[json UpdateBool: @"criteria.overrideInstructions.roomNumberLocked" value: NO];
[json UpdateBool: @"criteria.overrideInstructions.holdRoom" value: NO];
[json UpdateBool: @"criteria.overrideInstructions.overrideExternalChecks" value: NO];
[json UpdateBool: @"criteria.overrideInstructions.dayUseReserved" value: NO];
[json UpdateBool: @"criteria.updateRoomTypeCharged" value: YES];
[json UpdateBool: @"criteria.includeDepartureRooms" value: YES];
[json UpdateBool: @"criteria.roomNumberLocked" value: NO];
[json UpdateString: @"criteria.oldRoomStatus" value: @"Dirty"];
[json UpdateString: @"criteria.reasonCode" value: @"NSE"];
[json UpdateString: @"criteria.description" value: @"Noise Complaint"];

[http SetRequestHeader: @"Content-Type" value: @"application/json"];
[http SetRequestHeader: @"x-hotelid" value: @"{{HotelId}}"];
// Adds the "Authorization: Bearer <access_token>" header.
http.AuthToken = @"<access_token>";
[http SetRequestHeader: @"x-app-key" value: @"{{AppKey}}"];

CkoStringBuilder *sbRequestBody = [[CkoStringBuilder alloc] init];
[json EmitSb: sbRequestBody];

CkoHttpResponse *resp = [http PTextSb: @"PUT" url: @"https://domain.com/fof/v0/hotels/{{HotelId}}/reservations/{{ReservationId}}/rooms/{{RoomId}}/roomMoves" textData: sbRequestBody charset: @"utf-8" contentType: @"application/json" md5: NO gzip: NO];
if (http.LastMethodSuccess == NO) {
    NSLog(@"%@",http.LastErrorText);
    return;
}

NSLog(@"%d",[resp.StatusCode intValue]);
NSLog(@"%@",resp.BodyStr);

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