Chilkat Online Tools

phpAx / ORACLE Hospitality OPERA Cloud REST API Workflows / Add notes to the event

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.

// {
//   "eventDetails": [
//     {
//       "eventPrimaryInfo": {
//         "eventId": {
//           "type": "EventId",
//           "idContext": "OPERA",
//           "id": "{{EventId}}"
//         },
//         "hotelId": "{{HotelId}}"
//       },
//       "eventNotes": [
//         {
//           "noteCode": "EVENT",
//           "internal": true,
//           "noteTitle": "Event",
//           "comment": "Event notes can go here",
//           "sequence": "2"
//         }
//       ]
//     }
//   ]
// }

// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.JsonObject')
$json = new COM("Chilkat.JsonObject");
$json->UpdateString('eventDetails[0].eventPrimaryInfo.eventId.type','EventId');
$json->UpdateString('eventDetails[0].eventPrimaryInfo.eventId.idContext','OPERA');
$json->UpdateString('eventDetails[0].eventPrimaryInfo.eventId.id','{{EventId}}');
$json->UpdateString('eventDetails[0].eventPrimaryInfo.hotelId','{{HotelId}}');
$json->UpdateString('eventDetails[0].eventNotes[0].noteCode','EVENT');
$json->UpdateBool('eventDetails[0].eventNotes[0].internal',1);
$json->UpdateString('eventDetails[0].eventNotes[0].noteTitle','Event');
$json->UpdateString('eventDetails[0].eventNotes[0].comment','Event notes can go here');
$json->UpdateString('eventDetails[0].eventNotes[0].sequence','2');

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

// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.StringBuilder')
$sbRequestBody = new COM("Chilkat.StringBuilder");
$json->EmitSb($sbRequestBody);

// resp is a Chilkat.HttpResponse
$resp = $http->PTextSb('PUT','https://domain.com/evm/v0/hotels/{{HotelId}}/events/{{EventId}}',$sbRequestBody,'utf-8','application/json',0,0);
if ($http->LastMethodSuccess == 0) {
    print $http->LastErrorText . "\n";
    exit;
}

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


?>

Curl Command

curl -X PUT
	-H "Authorization: Bearer <access_token>"
	-H "x-app-key: {{AppKey}}"
	-H "x-hotelid: {{HotelId}}"
	-d '{
    "eventDetails": [
        {
            "eventPrimaryInfo": {
                "eventId": {
                    "type": "EventId",
                    "idContext": "OPERA",
                    "id": "{{EventId}}"
                },
                "hotelId": "{{HotelId}}"
            },
            "eventNotes": [
                {
                    "noteCode": "EVENT",
                    "internal": true,
                    "noteTitle": "Event",
                    "comment": "Event notes can go here",
                    "sequence": "2"
                }
            ]
        }
    ]
}'
https://domain.com/evm/v0/hotels/{{HotelId}}/events/{{EventId}}

Postman Collection Item JSON

{
  "name": "Add notes to the event",
  "request": {
    "auth": {
      "type": "bearer",
      "bearer": [
        {
          "key": "token",
          "value": "{{Token}}",
          "type": "string"
        }
      ]
    },
    "method": "PUT",
    "header": [
      {
        "key": "x-app-key",
        "type": "text",
        "value": "{{AppKey}}"
      },
      {
        "key": "x-hotelid",
        "type": "text",
        "value": "{{HotelId}}"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\r\n    \"eventDetails\": [\r\n        {\r\n            \"eventPrimaryInfo\": {\r\n                \"eventId\": {\r\n                    \"type\": \"EventId\",\r\n                    \"idContext\": \"OPERA\",\r\n                    \"id\": \"{{EventId}}\"\r\n                },\r\n                \"hotelId\": \"{{HotelId}}\"\r\n            },\r\n            \"eventNotes\": [\r\n                {\r\n                    \"noteCode\": \"EVENT\",\r\n                    \"internal\": true,\r\n                    \"noteTitle\": \"Event\",\r\n                    \"comment\": \"Event notes can go here\",\r\n                    \"sequence\": \"2\"\r\n                }\r\n            ]\r\n        }\r\n    ]\r\n}",
      "options": {
        "raw": {
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "{{HostName}}/evm/v0/hotels/{{HotelId}}/events/{{EventId}}",
      "host": [
        "{{HostName}}"
      ],
      "path": [
        "evm",
        "v0",
        "hotels",
        "{{HotelId}}",
        "events",
        "{{EventId}}"
      ]
    }
  },
  "response": [
  ]
}