Chilkat Online Tools

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

Back to Collection Items

load ./chilkat.dll

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

set http [new_CkHttp]

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

set json [new_CkJsonObject]

CkJsonObject_UpdateString $json "eventDetails[0].eventPrimaryInfo.eventId.type" "EventId"
CkJsonObject_UpdateString $json "eventDetails[0].eventPrimaryInfo.eventId.idContext" "OPERA"
CkJsonObject_UpdateString $json "eventDetails[0].eventPrimaryInfo.eventId.id" "{{EventId}}"
CkJsonObject_UpdateString $json "eventDetails[0].eventPrimaryInfo.hotelId" "{{HotelId}}"
CkJsonObject_UpdateString $json "eventDetails[0].eventNotes[0].noteCode" "EVENT"
CkJsonObject_UpdateBool $json "eventDetails[0].eventNotes[0].internal" 1
CkJsonObject_UpdateString $json "eventDetails[0].eventNotes[0].noteTitle" "Event"
CkJsonObject_UpdateString $json "eventDetails[0].eventNotes[0].comment" "Event notes can go here"
CkJsonObject_UpdateString $json "eventDetails[0].eventNotes[0].sequence" "2"

CkHttp_SetRequestHeader $http "x-app-key" "{{AppKey}}"
CkHttp_SetRequestHeader $http "x-hotelid" "{{HotelId}}"
# Adds the "Authorization: Bearer <access_token>" header.
CkHttp_put_AuthToken $http "<access_token>"

set sbRequestBody [new_CkStringBuilder]

CkJsonObject_EmitSb $json $sbRequestBody

# resp is a CkHttpResponse
set resp [CkHttp_PTextSb $http "PUT" "https://domain.com/evm/v0/hotels/{{HotelId}}/events/{{EventId}}" $sbRequestBody "utf-8" "application/json" 0 0]
if {[CkHttp_get_LastMethodSuccess $http] == 0} then {
    puts [CkHttp_lastErrorText $http]
    delete_CkHttp $http
    delete_CkJsonObject $json
    delete_CkStringBuilder $sbRequestBody
    exit
}

puts [CkHttpResponse_get_StatusCode $resp]
puts [CkHttpResponse_bodyStr $resp]
delete_CkHttpResponse $resp


delete_CkHttp $http
delete_CkJsonObject $json
delete_CkStringBuilder $sbRequestBody

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