Chilkat Online Tools

SQL Server / ORACLE Hospitality OPERA Cloud REST API Workflows / Update an existing Rate Plan

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.

    -- {
    --   "ratePlan": {
    --     "primaryDetails": {
    --       "description": {
    --         "defaultText": "Description of rate code "
    --       },
    --       "startSellDate": "2021-07-03",
    --       "endSellDate": "2021-08-31",
    --       "privilegedRate": false,
    --       "privilegedRateRestriction": false,
    --       "lockStatus": "Unlocked"
    --     },
    --     "classifications": {
    --       "rateCategory": "PHONE",
    --       "marketCode": "BUSINESS"
    --     },
    --     "roomTypeList": [
    --       {
    --         "code": "ECO"
    --       },
    --       {
    --         "code": "SUP"
    --       }
    --     ],
    --     "mobileCheckinAllowed": false,
    --     "mobileCheckoutAllowed": false,
    --     "hotelId": "{{HotelId}}",
    --     "ratePlanCode": "{{RatePlanCode}}",
    --     "supressRate": false,
    --     "printRate": true,
    --     "discountAllowed": false,
    --     "redemption": false,
    --     "bARRate": false,
    --     "daily": false,
    --     "tiered": false,
    --     "dayUse": false,
    --     "dayType": false,
    --     "complimentary": false,
    --     "houseUse": false,
    --     "negotiated": false,
    --     "ownerRate": false,
    --     "membershipEligible": true,
    --     "advancedDailyBase": false,
    --     "advancedDailyRate": false
    --   }
    -- }

    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, 'UpdateString', @success OUT, 'ratePlan.primaryDetails.description.defaultText', 'Description of rate code '
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'ratePlan.primaryDetails.startSellDate', '2021-07-03'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'ratePlan.primaryDetails.endSellDate', '2021-08-31'
    EXEC sp_OAMethod @json, 'UpdateBool', @success OUT, 'ratePlan.primaryDetails.privilegedRate', 0
    EXEC sp_OAMethod @json, 'UpdateBool', @success OUT, 'ratePlan.primaryDetails.privilegedRateRestriction', 0
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'ratePlan.primaryDetails.lockStatus', 'Unlocked'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'ratePlan.classifications.rateCategory', 'PHONE'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'ratePlan.classifications.marketCode', 'BUSINESS'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'ratePlan.roomTypeList[0].code', 'ECO'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'ratePlan.roomTypeList[1].code', 'SUP'
    EXEC sp_OAMethod @json, 'UpdateBool', @success OUT, 'ratePlan.mobileCheckinAllowed', 0
    EXEC sp_OAMethod @json, 'UpdateBool', @success OUT, 'ratePlan.mobileCheckoutAllowed', 0
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'ratePlan.hotelId', '{{HotelId}}'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'ratePlan.ratePlanCode', '{{RatePlanCode}}'
    EXEC sp_OAMethod @json, 'UpdateBool', @success OUT, 'ratePlan.supressRate', 0
    EXEC sp_OAMethod @json, 'UpdateBool', @success OUT, 'ratePlan.printRate', 1
    EXEC sp_OAMethod @json, 'UpdateBool', @success OUT, 'ratePlan.discountAllowed', 0
    EXEC sp_OAMethod @json, 'UpdateBool', @success OUT, 'ratePlan.redemption', 0
    EXEC sp_OAMethod @json, 'UpdateBool', @success OUT, 'ratePlan.bARRate', 0
    EXEC sp_OAMethod @json, 'UpdateBool', @success OUT, 'ratePlan.daily', 0
    EXEC sp_OAMethod @json, 'UpdateBool', @success OUT, 'ratePlan.tiered', 0
    EXEC sp_OAMethod @json, 'UpdateBool', @success OUT, 'ratePlan.dayUse', 0
    EXEC sp_OAMethod @json, 'UpdateBool', @success OUT, 'ratePlan.dayType', 0
    EXEC sp_OAMethod @json, 'UpdateBool', @success OUT, 'ratePlan.complimentary', 0
    EXEC sp_OAMethod @json, 'UpdateBool', @success OUT, 'ratePlan.houseUse', 0
    EXEC sp_OAMethod @json, 'UpdateBool', @success OUT, 'ratePlan.negotiated', 0
    EXEC sp_OAMethod @json, 'UpdateBool', @success OUT, 'ratePlan.ownerRate', 0
    EXEC sp_OAMethod @json, 'UpdateBool', @success OUT, 'ratePlan.membershipEligible', 1
    EXEC sp_OAMethod @json, 'UpdateBool', @success OUT, 'ratePlan.advancedDailyBase', 0
    EXEC sp_OAMethod @json, 'UpdateBool', @success OUT, 'ratePlan.advancedDailyRate', 0

    EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'Content-Type', 'application/json;charset=UTF-8'
    EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'x-hotelid', '{{HotelId}}'
    -- Adds the "Authorization: Bearer <access_token>" header.
    EXEC sp_OASetProperty @http, 'AuthToken', '<access_token>'
    EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'Accept', 'application/json;charset=UTF-8'
    EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'x-app-key', '{{AppKey}}'

    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/rtp/v0/hotels/{{HotelId}}/ratePlans/{{RatePlanCode}}', @sbRequestBody, 'utf-8', 'application/json;charset=UTF-8', 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 "Content-Type: application/json;charset=UTF-8"
	-H "Accept: application/json;charset=UTF-8"
	-H "x-hotelid: {{HotelId}}"
	-H "x-app-key: {{AppKey}}"
	-d '{
    "ratePlan": {
        "primaryDetails": {
            "description": {
                "defaultText": "Description of rate code "
            },
            "startSellDate": "2021-07-03",
            "endSellDate": "2021-08-31",
            "privilegedRate": false,
            "privilegedRateRestriction": false,
            "lockStatus": "Unlocked"
        },
        "classifications": {
            "rateCategory": "PHONE",
            "marketCode": "BUSINESS"
        },
        "roomTypeList": [
            {
                "code": "ECO"
            },
            {
                "code": "SUP"
            }
        ],
        "mobileCheckinAllowed": false,
        "mobileCheckoutAllowed": false,
        "hotelId": "{{HotelId}}",
        "ratePlanCode": "{{RatePlanCode}}",
        "supressRate": false,
        "printRate": true,
        "discountAllowed": false,
        "redemption": false,
        "bARRate": false,
        "daily": false,
        "tiered": false,
        "dayUse": false,
        "dayType": false,
        "complimentary": false,
        "houseUse": false,
        "negotiated": false,
        "ownerRate": false,
        "membershipEligible": true,
        "advancedDailyBase": false,
        "advancedDailyRate": false
    }
}'
https://domain.com/rtp/v0/hotels/{{HotelId}}/ratePlans/{{RatePlanCode}}

Postman Collection Item JSON

{
  "name": "Update an existing Rate Plan",
  "request": {
    "auth": {
      "type": "bearer",
      "bearer": [
        {
          "key": "token",
          "value": "{{Token}}",
          "type": "string"
        }
      ]
    },
    "method": "PUT",
    "header": [
      {
        "key": "Content-Type",
        "type": "text",
        "value": "application/json;charset=UTF-8"
      },
      {
        "key": "Accept",
        "type": "text",
        "value": "application/json;charset=UTF-8"
      },
      {
        "key": "x-hotelid",
        "type": "text",
        "value": "{{HotelId}}"
      },
      {
        "key": "x-app-key",
        "type": "text",
        "value": "{{AppKey}}"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\r\n    \"ratePlan\": {\r\n        \"primaryDetails\": {\r\n            \"description\": {\r\n                \"defaultText\": \"Description of rate code \"\r\n            },\r\n            \"startSellDate\": \"2021-07-03\",\r\n            \"endSellDate\": \"2021-08-31\",\r\n            \"privilegedRate\": false,\r\n            \"privilegedRateRestriction\": false,\r\n            \"lockStatus\": \"Unlocked\"\r\n        },\r\n        \"classifications\": {\r\n            \"rateCategory\": \"PHONE\",\r\n            \"marketCode\": \"BUSINESS\"\r\n        },\r\n        \"roomTypeList\": [\r\n            {\r\n                \"code\": \"ECO\"\r\n            },\r\n            {\r\n                \"code\": \"SUP\"\r\n            }\r\n        ],\r\n        \"mobileCheckinAllowed\": false,\r\n        \"mobileCheckoutAllowed\": false,\r\n        \"hotelId\": \"{{HotelId}}\",\r\n        \"ratePlanCode\": \"{{RatePlanCode}}\",\r\n        \"supressRate\": false,\r\n        \"printRate\": true,\r\n        \"discountAllowed\": false,\r\n        \"redemption\": false,\r\n        \"bARRate\": false,\r\n        \"daily\": false,\r\n        \"tiered\": false,\r\n        \"dayUse\": false,\r\n        \"dayType\": false,\r\n        \"complimentary\": false,\r\n        \"houseUse\": false,\r\n        \"negotiated\": false,\r\n        \"ownerRate\": false,\r\n        \"membershipEligible\": true,\r\n        \"advancedDailyBase\": false,\r\n        \"advancedDailyRate\": false\r\n    }\r\n}"
    },
    "url": {
      "raw": "{{HostName}}/rtp/v0/hotels/{{HotelId}}/ratePlans/{{RatePlanCode}}",
      "host": [
        "{{HostName}}"
      ],
      "path": [
        "rtp",
        "v0",
        "hotels",
        "{{HotelId}}",
        "ratePlans",
        "{{RatePlanCode}}"
      ]
    }
  },
  "response": [
  ]
}