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.
; {
; "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
; }
; ]
; }
json.i = CkJsonObject::ckCreate()
If json.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckUpdateString(json,"blocks[0].blockIdList[0].type","Block")
CkJsonObject::ckUpdateString(json,"blocks[0].blockIdList[0].idContext","OPERA")
CkJsonObject::ckUpdateString(json,"blocks[0].blockIdList[0].id","{{BlockId}}")
CkJsonObject::ckUpdateString(json,"blocks[0].comments.commentInfo[0].comment.commentTitle","Block note title")
CkJsonObject::ckUpdateString(json,"blocks[0].comments.commentInfo[0].comment.type","BOOK")
CkJsonObject::ckUpdateBool(json,"blocks[0].comments.commentInfo[0].comment.internal",1)
CkJsonObject::ckUpdateString(json,"blocks[0].comments.commentInfo[0].comment.hotelId","{{HotelId}}")
CkJsonObject::ckUpdateString(json,"blocks[0].comments.commentInfo[0].comment.text.value","Block notes can go here")
CkJsonObject::ckUpdateString(json,"blocks[0].hotelId","{{HotelId}}")
CkJsonObject::ckUpdateBool(json,"blocks[0].markAsRecentlyAccessed",0)
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/blk/v0/hotels/{{HotelId}}/blocks/{{BlockId}}",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-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": [
]
}