Chilkat Online Tools

phpAx / ORACLE Hospitality OPERA Cloud REST API Workflows / Cancel a reservation

Back to Collection Items

<?php

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

// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.Http')
$http = new COM("Chilkat.Http");

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

// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.JsonObject')
$json = new COM("Chilkat.JsonObject");
$json->UpdateString('reason.description','Trip Cancelled');
$json->UpdateString('reason.code','CXL');
$json->UpdateString('reservations[0].reservationIdList[0].id','{{ReservationId}}');
$json->UpdateString('reservations[0].reservationIdList[0].type','Reservation');
$json->UpdateString('reservations[0].roomStatus','Inspected');
$json->UpdateString('reservations[0].allowedActions[0]','Cancel');
$json->UpdateString('reservations[0].hotelId','{{HotelId}}');
$json->UpdateBool('reservations[0].cxlInstr.deleteResTraces',0);
$json->UpdateBool('verificationOnly',1);

$http->SetRequestHeader('Content-Type','application/json');
$http->SetRequestHeader('x-app-key','{{AppKey}}');
// Adds the "Authorization: Bearer <access_token>" header.
$http->AuthToken = '<access_token>';
$http->SetRequestHeader('x-hotelId','{{HotelId}}');

// resp is a Chilkat.HttpResponse
$resp = $http->PostJson3('https://domain.com/rsv/v1/hotels/{{HotelId}}/reservations/{{ReservationId}}/cancellations','application/json',$json);
if ($http->LastMethodSuccess == 0) {
    print $http->LastErrorText . "\n";
    exit;
}

print $resp->StatusCode . "\n";
print $resp->BodyStr . "\n";


?>

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