Chilkat Online Tools

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

Back to Collection Items

IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.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.

    ; {
    ;   "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"
    ;         }
    ;       ]
    ;     }
    ;   ]
    ; }

    json.i = CkJsonObject::ckCreate()
    If json.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckUpdateString(json,"eventDetails[0].eventPrimaryInfo.eventId.type","EventId")
    CkJsonObject::ckUpdateString(json,"eventDetails[0].eventPrimaryInfo.eventId.idContext","OPERA")
    CkJsonObject::ckUpdateString(json,"eventDetails[0].eventPrimaryInfo.eventId.id","{{EventId}}")
    CkJsonObject::ckUpdateString(json,"eventDetails[0].eventPrimaryInfo.hotelId","{{HotelId}}")
    CkJsonObject::ckUpdateString(json,"eventDetails[0].eventNotes[0].noteCode","EVENT")
    CkJsonObject::ckUpdateBool(json,"eventDetails[0].eventNotes[0].internal",1)
    CkJsonObject::ckUpdateString(json,"eventDetails[0].eventNotes[0].noteTitle","Event")
    CkJsonObject::ckUpdateString(json,"eventDetails[0].eventNotes[0].comment","Event notes can go here")
    CkJsonObject::ckUpdateString(json,"eventDetails[0].eventNotes[0].sequence","2")

    CkHttp::ckSetRequestHeader(http,"x-app-key","{{AppKey}}")
    CkHttp::ckSetRequestHeader(http,"x-hotelid","{{HotelId}}")
    ; Adds the "Authorization: Bearer <access_token>" header.
    CkHttp::setCkAuthToken(http, "<access_token>")

    sbRequestBody.i = CkStringBuilder::ckCreate()
    If sbRequestBody.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckEmitSb(json,sbRequestBody)

    resp.i = CkHttp::ckPTextSb(http,"PUT","https://domain.com/evm/v0/hotels/{{HotelId}}/events/{{EventId}}",sbRequestBody,"utf-8","application/json",0,0)
    If CkHttp::ckLastMethodSuccess(http) = 0
        Debug CkHttp::ckLastErrorText(http)
        CkHttp::ckDispose(http)
        CkJsonObject::ckDispose(json)
        CkStringBuilder::ckDispose(sbRequestBody)
        ProcedureReturn
    EndIf

    Debug Str(CkHttpResponse::ckStatusCode(resp))
    Debug CkHttpResponse::ckBodyStr(resp)
    CkHttpResponse::ckDispose(resp)



    CkHttp::ckDispose(http)
    CkJsonObject::ckDispose(json)
    CkStringBuilder::ckDispose(sbRequestBody)


    ProcedureReturn
EndProcedure

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