Chilkat Online Tools

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

Back to Collection Items

LOCAL loHttp
LOCAL lnSuccess
LOCAL loJson
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.

* {
*   "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 CreateObject('Chilkat_9_5_0.JsonObject')
loJson = CreateObject('Chilkat.JsonObject')
loJson.UpdateString("reservationIdList[0].type","Reservation")
loJson.UpdateString("reservationIdList[0].id","{{ReservationId}}")
loJson.UpdateString("keyOptions","GAR,RFT")
loJson.UpdateString("keyValidityStart","2021-22-25 12:00:00.0")
loJson.UpdateString("noOfKeys","1")
loJson.UpdateString("encoderTerminal","APIRQ")
loJson.UpdateString("encoderId.id","0")
loJson.UpdateString("resort","{{HotelId}}")
loJson.UpdateString("keyType","New")
loJson.UpdateString("keyValidityEnd","2021-11-26 13:00:00.0")

loResp = loHttp.PostJson3("https://domain.com/fof/v0/hotels/hotelId/reservations/reservationId/roomKeys","application/json",loJson)
IF (loHttp.LastMethodSuccess = 0) THEN
    ? loHttp.LastErrorText
    RELEASE loHttp
    RELEASE loJson
    CANCEL
ENDIF

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

RELEASE loHttp
RELEASE loJson

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