Chilkat Online Tools

lianja / ORACLE Hospitality OPERA Cloud REST API Workflows / Add notes to a block

Back to Collection Items

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

loHttp = createobject("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.

// {
//   "blocks": [
//     {
//       "blockIdList": [
//         {
//           "type": "Block",
//           "idContext": "OPERA",
//           "id": "{{BlockId}}"
//         }
//       ],
//       "comments": {
//         "commentInfo": [
//           {
//             "comment": {
//               "commentTitle": "Block note title",
//               "type": "BOOK",
//               "internal": true,
//               "hotelId": "{{HotelId}}",
//               "text": {
//                 "value": "Block notes can go here"
//               }
//             }
//           }
//         ]
//       },
//       "hotelId": "{{HotelId}}",
//       "markAsRecentlyAccessed": false
//     }
//   ]
// }

loJson = createobject("CkJsonObject")
loJson.UpdateString("blocks[0].blockIdList[0].type","Block")
loJson.UpdateString("blocks[0].blockIdList[0].idContext","OPERA")
loJson.UpdateString("blocks[0].blockIdList[0].id","{{BlockId}}")
loJson.UpdateString("blocks[0].comments.commentInfo[0].comment.commentTitle","Block note title")
loJson.UpdateString("blocks[0].comments.commentInfo[0].comment.type","BOOK")
loJson.UpdateBool("blocks[0].comments.commentInfo[0].comment.internal",.T.)
loJson.UpdateString("blocks[0].comments.commentInfo[0].comment.hotelId","{{HotelId}}")
loJson.UpdateString("blocks[0].comments.commentInfo[0].comment.text.value","Block notes can go here")
loJson.UpdateString("blocks[0].hotelId","{{HotelId}}")
loJson.UpdateBool("blocks[0].markAsRecentlyAccessed",.F.)

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

loSbRequestBody = createobject("CkStringBuilder")
loJson.EmitSb(loSbRequestBody)

loResp = loHttp.PTextSb("PUT","https://domain.com/blk/v0/hotels/{{HotelId}}/blocks/{{BlockId}}",loSbRequestBody,"utf-8","application/json",.F.,.F.)
if (loHttp.LastMethodSuccess = .F.) then
    ? loHttp.LastErrorText
    release loHttp
    release loJson
    release loSbRequestBody
    return
endif

? str(loResp.StatusCode)
? loResp.BodyStr
release loResp


release loHttp
release loJson
release loSbRequestBody

Curl Command

curl -X PUT
	-H "Authorization: Bearer <access_token>"
	-H "x-hotelid: {{HotelId}}"
	-H "x-app-key: {{AppKey}}"
	-d '{
    "blocks": [
        {
            "blockIdList": [
                {
                    "type": "Block",
                    "idContext": "OPERA",
                    "id": "{{BlockId}}"
                }
            ],
            "comments": {
                "commentInfo": [
                    {
                        "comment": {
                            "commentTitle": "Block note title",
                            "type": "BOOK",
                            "internal": true,
                            "hotelId": "{{HotelId}}",
                            "text": {
                                "value": "Block notes can go here"
                            }
                        }
                    }
                ]
            },
            "hotelId": "{{HotelId}}",
            "markAsRecentlyAccessed": false
        }
    ]
}'
https://domain.com/blk/v0/hotels/{{HotelId}}/blocks/{{BlockId}}

Postman Collection Item JSON

{
  "name": "Add notes to a block",
  "event": [
    {
      "listen": "test",
      "script": {
        "exec": [
          ""
        ],
        "type": "text/javascript"
      }
    }
  ],
  "request": {
    "auth": {
      "type": "bearer",
      "bearer": [
        {
          "key": "token",
          "value": "{{Token}}",
          "type": "string"
        }
      ]
    },
    "method": "PUT",
    "header": [
      {
        "key": "x-hotelid",
        "value": "{{HotelId}}"
      },
      {
        "key": "x-app-key",
        "value": "{{AppKey}}"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\r\n    \"blocks\": [\r\n        {\r\n            \"blockIdList\": [\r\n                {\r\n                    \"type\": \"Block\",\r\n                    \"idContext\": \"OPERA\",\r\n                    \"id\": \"{{BlockId}}\"\r\n                }\r\n            ],\r\n            \"comments\": {\r\n                \"commentInfo\": [\r\n                    {\r\n                        \"comment\": {\r\n                            \"commentTitle\": \"Block note title\",\r\n                            \"type\": \"BOOK\",\r\n                            \"internal\": true,\r\n                            \"hotelId\": \"{{HotelId}}\",\r\n                            \"text\": {\r\n                                \"value\": \"Block notes can go here\"\r\n                            }\r\n                        }\r\n                    }\r\n                ]\r\n            },\r\n            \"hotelId\": \"{{HotelId}}\",\r\n            \"markAsRecentlyAccessed\": false\r\n        }\r\n    ]\r\n}",
      "options": {
        "raw": {
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "{{HostName}}/blk/v0/hotels/{{HotelId}}/blocks/{{BlockId}}",
      "host": [
        "{{HostName}}"
      ],
      "path": [
        "blk",
        "v0",
        "hotels",
        "{{HotelId}}",
        "blocks",
        "{{BlockId}}"
      ]
    }
  },
  "response": [
  ]
}