Chilkat Online Tools

phpAx / ORACLE Hospitality OPERA Cloud REST API Workflows / Create Room Key

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.

// {
//   "reservationIdList": [
//     {
//       "type": "Reservation",
//       "id": "{{ReservationId}}"
//     }
//   ],
//   "keyOptions": "GAR,RFT",
//   "keyValidityStart": "2021-22-25 12:00:00.0",
//   "noOfKeys": "1",
//   "encoderTerminal": "APIRQ",
//   "encoderId": {
//     "id": "0"
//   },
//   "resort": "{{HotelId}}",
//   "keyType": "New",
//   "keyValidityEnd": "2021-11-26 13:00:00.0"
// }

// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.JsonObject')
$json = new COM("Chilkat.JsonObject");
$json->UpdateString('reservationIdList[0].type','Reservation');
$json->UpdateString('reservationIdList[0].id','{{ReservationId}}');
$json->UpdateString('keyOptions','GAR,RFT');
$json->UpdateString('keyValidityStart','2021-22-25 12:00:00.0');
$json->UpdateString('noOfKeys','1');
$json->UpdateString('encoderTerminal','APIRQ');
$json->UpdateString('encoderId.id','0');
$json->UpdateString('resort','{{HotelId}}');
$json->UpdateString('keyType','New');
$json->UpdateString('keyValidityEnd','2021-11-26 13:00:00.0');

// resp is a Chilkat.HttpResponse
$resp = $http->PostJson3('https://domain.com/fof/v0/hotels/hotelId/reservations/reservationId/roomKeys','application/json',$json);
if ($http->LastMethodSuccess == 0) {
    print $http->LastErrorText . "\n";
    exit;
}

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


?>

Curl Command

curl -X POST
	-d '{
    "reservationIdList": [
        {
            "type": "Reservation",
            "id": "{{ReservationId}}"
        }
    ],
    "keyOptions": "GAR,RFT",
    "keyValidityStart": "2021-22-25 12:00:00.0",
    "noOfKeys": "1",
    "encoderTerminal": "APIRQ",
    "encoderId": {
        "id": "0"
    },
    "resort": "{{HotelId}}",
    "keyType": "New",
    "keyValidityEnd": "2021-11-26 13:00:00.0"
}'
https://domain.com/fof/v0/hotels/hotelId/reservations/reservationId/roomKeys

Postman Collection Item JSON

{
  "name": "Create Room Key",
  "request": {
    "method": "POST",
    "header": [
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n    \"reservationIdList\": [\n        {\n            \"type\": \"Reservation\",\n            \"id\": \"{{ReservationId}}\"\n        }\n    ],\n    \"keyOptions\": \"GAR,RFT\",\n    \"keyValidityStart\": \"2021-22-25 12:00:00.0\",\n    \"noOfKeys\": \"1\",\n    \"encoderTerminal\": \"APIRQ\",\n    \"encoderId\": {\n        \"id\": \"0\"\n    },\n    \"resort\": \"{{HotelId}}\",\n    \"keyType\": \"New\",\n    \"keyValidityEnd\": \"2021-11-26 13:00:00.0\"\n}",
      "options": {
        "raw": {
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "{{HostName}}/fof/v0/hotels/hotelId/reservations/reservationId/roomKeys",
      "host": [
        "{{HostName}}"
      ],
      "path": [
        "fof",
        "v0",
        "hotels",
        "hotelId",
        "reservations",
        "reservationId",
        "roomKeys"
      ]
    },
    "description": "This operation **postRoomKey** will only be available if the property has a valid intergration to a doorlocking system.\r\n\r\nencoderId = 0 is typically the designation that a digital key is requested rather than a physical key\r\n"
  },
  "response": [
  ]
}