Chilkat Online Tools

SQL Server / ORACLE Hospitality OPERA Cloud REST API Workflows / Update the Block's Status

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
    -- Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
    EXEC @hr = sp_OACreate 'Chilkat.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.

    -- {
    --   "verificationOnly": false,
    --   "changeBlockStatus": {
    --     "hotelId": "{{HotelId}}",
    --     "blockId": {
    --       "type": "Block",
    --       "idContext": "OPERA",
    --       "id": "{{BlockId}}"
    --     },
    --     "currentBlockStatus": "TEN",
    --     "newBlockStatus": "DEF",
    --     "reservationType": "GRPGTD",
    --     "overbookAll": true,
    --     "cancelAllPMReservations": false,
    --     "applyChangesToCateringSatus": false,
    --     "overrideEventsProcessingWarnings": true
    --   }
    -- }

    DECLARE @json int
    -- Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
    EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @json OUT

    EXEC sp_OAMethod @json, 'UpdateBool', @success OUT, 'verificationOnly', 0
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'changeBlockStatus.hotelId', '{{HotelId}}'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'changeBlockStatus.blockId.type', 'Block'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'changeBlockStatus.blockId.idContext', 'OPERA'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'changeBlockStatus.blockId.id', '{{BlockId}}'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'changeBlockStatus.currentBlockStatus', 'TEN'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'changeBlockStatus.newBlockStatus', 'DEF'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'changeBlockStatus.reservationType', 'GRPGTD'
    EXEC sp_OAMethod @json, 'UpdateBool', @success OUT, 'changeBlockStatus.overbookAll', 1
    EXEC sp_OAMethod @json, 'UpdateBool', @success OUT, 'changeBlockStatus.cancelAllPMReservations', 0
    EXEC sp_OAMethod @json, 'UpdateBool', @success OUT, 'changeBlockStatus.applyChangesToCateringSatus', 0
    EXEC sp_OAMethod @json, 'UpdateBool', @success OUT, 'changeBlockStatus.overrideEventsProcessingWarnings', 1

    EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'x-app-key', '{{AppKey}}'
    EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'x-hotelid', '{{HotelId}}'
    -- Adds the "Authorization: Bearer <access_token>" header.
    EXEC sp_OASetProperty @http, 'AuthToken', '<access_token>'

    DECLARE @sbRequestBody int
    -- Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
    EXEC @hr = sp_OACreate 'Chilkat.StringBuilder', @sbRequestBody OUT

    EXEC sp_OAMethod @json, 'EmitSb', @success OUT, @sbRequestBody

    DECLARE @resp int
    EXEC sp_OAMethod @http, 'PTextSb', @resp OUT, 'PUT', 'https://domain.com/blk/v0/hotels/{{HotelId}}/blocks/{{BlockId}}/status', @sbRequestBody, 'utf-8', 'application/json', 0, 0
    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
        EXEC @hr = sp_OADestroy @sbRequestBody
        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
    EXEC @hr = sp_OADestroy @sbRequestBody


END
GO

Curl Command

curl -X PUT
	-H "Authorization: Bearer <access_token>"
	-H "x-hotelid: {{HotelId}}"
	-H "x-app-key: {{AppKey}}"
	-d '{
    "verificationOnly": false,
    "changeBlockStatus": {
        "hotelId": "{{HotelId}}",
        "blockId": {
            "type": "Block",
            "idContext": "OPERA",
            "id": "{{BlockId}}"
        },
        "currentBlockStatus": "TEN",
        "newBlockStatus": "DEF",
        "reservationType": "GRPGTD",
        "overbookAll": true,
        "cancelAllPMReservations": false,
        "applyChangesToCateringSatus": false,
        "overrideEventsProcessingWarnings": true
    }
}'
https://domain.com/blk/v0/hotels/{{HotelId}}/blocks/{{BlockId}}/status

Postman Collection Item JSON

{
  "name": "Update the Block's Status",
  "request": {
    "auth": {
      "type": "bearer",
      "bearer": [
        {
          "key": "token",
          "value": "{{Token}}",
          "type": "string"
        }
      ]
    },
    "method": "PUT",
    "header": [
      {
        "key": "x-hotelid",
        "value": "{{HotelId}}"
      },
      {
        "key": "x-app-key",
        "value": "{{AppKey}}"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\r\n    \"verificationOnly\": false,\r\n    \"changeBlockStatus\": {\r\n        \"hotelId\": \"{{HotelId}}\",\r\n        \"blockId\": {\r\n            \"type\": \"Block\",\r\n            \"idContext\": \"OPERA\",\r\n            \"id\": \"{{BlockId}}\"\r\n        },\r\n        \"currentBlockStatus\": \"TEN\",\r\n        \"newBlockStatus\": \"DEF\",\r\n        \"reservationType\": \"GRPGTD\",\r\n        \"overbookAll\": true,\r\n        \"cancelAllPMReservations\": false,\r\n        \"applyChangesToCateringSatus\": false,\r\n        \"overrideEventsProcessingWarnings\": true\r\n    }\r\n}",
      "options": {
        "raw": {
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "{{HostName}}/blk/v0/hotels/{{HotelId}}/blocks/{{BlockId}}/status",
      "host": [
        "{{HostName}}"
      ],
      "path": [
        "blk",
        "v0",
        "hotels",
        "{{HotelId}}",
        "blocks",
        "{{BlockId}}",
        "status"
      ]
    },
    "description": "\"overbookAll\": true/ false.  Set this to false, to ensure relevant warnings are returned about changing the status.   Set to true, to override all warnings."
  },
  "response": [
  ]
}