Chilkat Online Tools

phpAx / ORACLE Hospitality OPERA Cloud REST API Workflows / 05. Pre-Arrival - putReservation (add pref)

Back to Collection Items

<?php

// 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 new COM('Chilkat_9_5_0.Chilkat.Http')
$http = new COM("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.

// {
//   "reservations": [
//     {
//       "reservationIdList": [
//         {
//           "type": "Reservation",
//           "id": "{{ReservationId}}"
//         }
//       ],
//       "preferenceCollection": [
//         {
//           "preference": [
//             {
//               "preferenceValue": "AWAY",
//               "hotels": "{{HotelId}}",
//               "global": false
//             }
//           ],
//           "preferenceType": "ROOM FEATURES"
//         }
//       ],
//       "hotelId": "{{HotelId}}",
//       "customReference": "",
//       "preRegistered": false,
//       "allowMobileCheckout": false
//     }
//   ]
// }

// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.JsonObject')
$json = new COM("Chilkat.JsonObject");
$json->UpdateString('reservations[0].reservationIdList[0].type','Reservation');
$json->UpdateString('reservations[0].reservationIdList[0].id','{{ReservationId}}');
$json->UpdateString('reservations[0].preferenceCollection[0].preference[0].preferenceValue','AWAY');
$json->UpdateString('reservations[0].preferenceCollection[0].preference[0].hotels','{{HotelId}}');
$json->UpdateBool('reservations[0].preferenceCollection[0].preference[0].global',0);
$json->UpdateString('reservations[0].preferenceCollection[0].preferenceType','ROOM FEATURES');
$json->UpdateString('reservations[0].hotelId','{{HotelId}}');
$json->UpdateString('reservations[0].customReference','');
$json->UpdateBool('reservations[0].preRegistered',0);
$json->UpdateBool('reservations[0].allowMobileCheckout',0);

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

// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.StringBuilder')
$sbRequestBody = new COM("Chilkat.StringBuilder");
$json->EmitSb($sbRequestBody);

// resp is a Chilkat.HttpResponse
$resp = $http->PTextSb('PUT','https://domain.com/rsv/v1/hotels/{{HotelId}}/reservations/{{ReservationId}}',$sbRequestBody,'utf-8','application/json',0,0);
if ($http->LastMethodSuccess == 0) {
    print $http->LastErrorText . "\n";
    exit;
}

print $resp->StatusCode . "\n";
print $resp->BodyStr . "\n";


?>

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 '{
    "reservations": [
        {
            "reservationIdList": [
                {
                    "type": "Reservation",
                    "id": "{{ReservationId}}"
                }
            ],
            "preferenceCollection": [
                {
                    "preference": [
                        {
                            "preferenceValue": "AWAY",
                            "hotels": "{{HotelId}}",
                            "global": false
                        }
                    ],
                    "preferenceType": "ROOM FEATURES"
                }
            ],
            "hotelId": "{{HotelId}}",
            "customReference": "",
            "preRegistered": false,
            "allowMobileCheckout": false
        }
    ]
}'
https://domain.com/rsv/v1/hotels/{{HotelId}}/reservations/{{ReservationId}}

Postman Collection Item JSON

{
  "name": "05. Pre-Arrival - putReservation (add pref)",
  "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",
        "value": "{{HotelId}}",
        "type": "text"
      },
      {
        "key": "x-app-key",
        "value": "{{AppKey}}",
        "type": "text"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\r\n    \"reservations\": [\r\n        {\r\n            \"reservationIdList\": [\r\n                {\r\n                    \"type\": \"Reservation\",\r\n                    \"id\": \"{{ReservationId}}\"\r\n                }\r\n            ],\r\n            \"preferenceCollection\": [\r\n                {\r\n                    \"preference\": [\r\n                        {\r\n                            \"preferenceValue\": \"AWAY\",\r\n                            \"hotels\": \"{{HotelId}}\",\r\n                            \"global\": false\r\n                        }\r\n                    ],\r\n                    \"preferenceType\": \"ROOM FEATURES\"\r\n                }\r\n            ],\r\n            \"hotelId\": \"{{HotelId}}\",\r\n            \"customReference\": \"\",\r\n            \"preRegistered\": false,\r\n            \"allowMobileCheckout\": false\r\n        }\r\n    ]\r\n}",
      "options": {
        "raw": {
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "{{HostName}}/rsv/v1/hotels/{{HotelId}}/reservations/{{ReservationId}}",
      "host": [
        "{{HostName}}"
      ],
      "path": [
        "rsv",
        "v1",
        "hotels",
        "{{HotelId}}",
        "reservations",
        "{{ReservationId}}"
      ]
    },
    "description": "To update an existing reservation in OPERA by attaching Preferences."
  },
  "response": [
  ]
}