Back to Collection Items
IncludeFile "CkJsonObject.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.
; {
; "reason": {
; "description": "Trip Cancelled",
; "code": "CXL"
; },
; "reservations": [
; {
; "reservationIdList": [
; {
; "id": "{{ReservationId}}",
; "type": "Reservation"
; }
; ],
; "roomStatus": "Inspected",
; "allowedActions": [
; "Cancel"
; ],
; "hotelId": "{{HotelId}}",
; "cxlInstr": {
; "deleteResTraces": false
; }
; }
; ],
; "verificationOnly": true
; }
json.i = CkJsonObject::ckCreate()
If json.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckUpdateString(json,"reason.description","Trip Cancelled")
CkJsonObject::ckUpdateString(json,"reason.code","CXL")
CkJsonObject::ckUpdateString(json,"reservations[0].reservationIdList[0].id","{{ReservationId}}")
CkJsonObject::ckUpdateString(json,"reservations[0].reservationIdList[0].type","Reservation")
CkJsonObject::ckUpdateString(json,"reservations[0].roomStatus","Inspected")
CkJsonObject::ckUpdateString(json,"reservations[0].allowedActions[0]","Cancel")
CkJsonObject::ckUpdateString(json,"reservations[0].hotelId","{{HotelId}}")
CkJsonObject::ckUpdateBool(json,"reservations[0].cxlInstr.deleteResTraces",0)
CkJsonObject::ckUpdateBool(json,"verificationOnly",1)
CkHttp::ckSetRequestHeader(http,"Content-Type","application/json")
CkHttp::ckSetRequestHeader(http,"x-app-key","{{AppKey}}")
; Adds the "Authorization: Bearer <access_token>" header.
CkHttp::setCkAuthToken(http, "<access_token>")
CkHttp::ckSetRequestHeader(http,"x-hotelId","{{HotelId}}")
resp.i = CkHttp::ckPostJson3(http,"https://domain.com/rsv/v1/hotels/{{HotelId}}/reservations/{{ReservationId}}/cancellations","application/json",json)
If CkHttp::ckLastMethodSuccess(http) = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
ProcedureReturn
EndIf
Debug Str(CkHttpResponse::ckStatusCode(resp))
Debug CkHttpResponse::ckBodyStr(resp)
CkHttpResponse::ckDispose(resp)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
ProcedureReturn
EndProcedure
Curl Command
curl -X POST
-H "Authorization: Bearer <access_token>"
-H "Content-Type: application/json"
-H "x-app-key: {{AppKey}}"
-H "x-hotelId: {{HotelId}}"
-d '{
"reason": {
"description": "Trip Cancelled",
"code": "CXL"
},
"reservations": [
{
"reservationIdList": [
{
"id": "{{ReservationId}}",
"type": "Reservation"
}
],
"roomStatus": "Inspected",
"allowedActions": [
"Cancel"
],
"hotelId": "{{HotelId}}",
"cxlInstr": {
"deleteResTraces": false
}
}
],
"verificationOnly": true
}'
https://domain.com/rsv/v1/hotels/{{HotelId}}/reservations/{{ReservationId}}/cancellations
Postman Collection Item JSON
{
"name": "Cancel a reservation",
"request": {
"auth": {
"type": "bearer",
"bearer": [
{
"key": "token",
"value": "{{Token}}",
"type": "string"
}
]
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"name": "Content-Type",
"type": "text",
"value": "application/json"
},
{
"key": "x-app-key",
"type": "text",
"value": "{{AppKey}}"
},
{
"key": "x-hotelId",
"type": "text",
"value": "{{HotelId}}"
}
],
"body": {
"mode": "raw",
"raw": "{\r\n \"reason\": {\r\n \"description\": \"Trip Cancelled\",\r\n \"code\": \"CXL\"\r\n },\r\n \"reservations\": [\r\n {\r\n \"reservationIdList\": [\r\n {\r\n \"id\": \"{{ReservationId}}\",\r\n \"type\": \"Reservation\"\r\n }\r\n ],\r\n \"roomStatus\": \"Inspected\",\r\n \"allowedActions\": [\r\n \"Cancel\"\r\n ],\r\n \"hotelId\": \"{{HotelId}}\",\r\n \"cxlInstr\": {\r\n \"deleteResTraces\": false\r\n }\r\n }\r\n ],\r\n \"verificationOnly\": true\r\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{HostName}}/rsv/v1/hotels/{{HotelId}}/reservations/{{ReservationId}}/cancellations",
"host": [
"{{HostName}}"
],
"path": [
"rsv",
"v1",
"hotels",
"{{HotelId}}",
"reservations",
"{{ReservationId}}",
"cancellations"
]
},
"description": "To cancel a reservaiton in OPERA Cloud."
},
"response": [
]
}