Chilkat Online Tools

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

Back to Collection Items

IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.pb"

Procedure ChilkatExample()

    ; This example assumes the Chilkat API to have been previously unlocked.
    ; See Global Unlock Sample for sample code.

    http.i = CkHttp::ckCreate()
    If http.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success.i

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

    json.i = CkJsonObject::ckCreate()
    If json.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

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

    CkHttp::ckSetRequestHeader(http,"Content-Type","application/json;charset=UTF-8")
    CkHttp::ckSetRequestHeader(http,"x-hotelid","{{HotelId}}")
    ; Adds the "Authorization: Bearer <access_token>" header.
    CkHttp::setCkAuthToken(http, "<access_token>")
    CkHttp::ckSetRequestHeader(http,"Accept","application/json;charset=UTF-8")
    CkHttp::ckSetRequestHeader(http,"x-app-key","{{AppKey}}")

    sbRequestBody.i = CkStringBuilder::ckCreate()
    If sbRequestBody.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckEmitSb(json,sbRequestBody)

    resp.i = CkHttp::ckPTextSb(http,"PUT","https://domain.com/rtp/v0/hotels/{{HotelId}}/ratePlans/{{RatePlanCode}}",sbRequestBody,"utf-8","application/json;charset=UTF-8",0,0)
    If CkHttp::ckLastMethodSuccess(http) = 0
        Debug CkHttp::ckLastErrorText(http)
        CkHttp::ckDispose(http)
        CkJsonObject::ckDispose(json)
        CkStringBuilder::ckDispose(sbRequestBody)
        ProcedureReturn
    EndIf

    Debug Str(CkHttpResponse::ckStatusCode(resp))
    Debug CkHttpResponse::ckBodyStr(resp)
    CkHttpResponse::ckDispose(resp)



    CkHttp::ckDispose(http)
    CkJsonObject::ckDispose(json)
    CkStringBuilder::ckDispose(sbRequestBody)


    ProcedureReturn
EndProcedure

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