Chilkat Online Tools

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

Back to Collection Items

require 'chilkat'

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

http = Chilkat::CkHttp.new()

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

json = Chilkat::CkJsonObject.new()
json.UpdateBool("verificationOnly",false)
json.UpdateString("changeBlockStatus.hotelId","{{HotelId}}")
json.UpdateString("changeBlockStatus.blockId.type","Block")
json.UpdateString("changeBlockStatus.blockId.idContext","OPERA")
json.UpdateString("changeBlockStatus.blockId.id","{{BlockId}}")
json.UpdateString("changeBlockStatus.currentBlockStatus","TEN")
json.UpdateString("changeBlockStatus.newBlockStatus","DEF")
json.UpdateString("changeBlockStatus.reservationType","GRPGTD")
json.UpdateBool("changeBlockStatus.overbookAll",true)
json.UpdateBool("changeBlockStatus.cancelAllPMReservations",false)
json.UpdateBool("changeBlockStatus.applyChangesToCateringSatus",false)
json.UpdateBool("changeBlockStatus.overrideEventsProcessingWarnings",true)

http.SetRequestHeader("x-app-key","{{AppKey}}")
http.SetRequestHeader("x-hotelid","{{HotelId}}")
# Adds the "Authorization: Bearer <access_token>" header.
http.put_AuthToken("<access_token>")

sbRequestBody = Chilkat::CkStringBuilder.new()
json.EmitSb(sbRequestBody)

# resp is a CkHttpResponse
resp = http.PTextSb("PUT","https://domain.com/blk/v0/hotels/{{HotelId}}/blocks/{{BlockId}}/status",sbRequestBody,"utf-8","application/json",false,false)
if (http.get_LastMethodSuccess() == false)
    print http.lastErrorText() + "\n";
    exit
end

print resp.get_StatusCode().to_s() + "\n";
print resp.bodyStr() + "\n";

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