Chilkat Online Tools

SQL Server / ORACLE Hospitality OPERA Cloud REST API Workflows / Create Room Key

Back to Collection Items

-- Important: See this note about string length limitations for strings returned by sp_OAMethod calls.
--
CREATE PROCEDURE ChilkatSample
AS
BEGIN
    DECLARE @hr int
    DECLARE @iTmp0 int
    -- Important: Do not use nvarchar(max).  See the warning about using nvarchar(max).
    DECLARE @sTmp0 nvarchar(4000)
    -- This example assumes the Chilkat API to have been previously unlocked.
    -- See Global Unlock Sample for sample code.

    DECLARE @http int
    EXEC @hr = sp_OACreate 'Chilkat_9_5_0.Http', @http OUT
    IF @hr <> 0
    BEGIN
        PRINT 'Failed to create ActiveX component'
        RETURN
    END

    DECLARE @success int

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

    DECLARE @json int
    EXEC @hr = sp_OACreate 'Chilkat_9_5_0.JsonObject', @json OUT

    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'reservationIdList[0].type', 'Reservation'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'reservationIdList[0].id', '{{ReservationId}}'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'keyOptions', 'GAR,RFT'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'keyValidityStart', '2021-22-25 12:00:00.0'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'noOfKeys', '1'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'encoderTerminal', 'APIRQ'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'encoderId.id', '0'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'resort', '{{HotelId}}'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'keyType', 'New'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'keyValidityEnd', '2021-11-26 13:00:00.0'

    DECLARE @resp int
    EXEC sp_OAMethod @http, 'PostJson3', @resp OUT, 'https://domain.com/fof/v0/hotels/hotelId/reservations/reservationId/roomKeys', 'application/json', @json
    EXEC sp_OAGetProperty @http, 'LastMethodSuccess', @iTmp0 OUT
    IF @iTmp0 = 0
      BEGIN
        EXEC sp_OAGetProperty @http, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @http
        EXEC @hr = sp_OADestroy @json
        RETURN
      END

    EXEC sp_OAGetProperty @resp, 'StatusCode', @iTmp0 OUT
    PRINT @iTmp0
    EXEC sp_OAGetProperty @resp, 'BodyStr', @sTmp0 OUT
    PRINT @sTmp0
    EXEC @hr = sp_OADestroy @resp


    EXEC @hr = sp_OADestroy @http
    EXEC @hr = sp_OADestroy @json


END
GO

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