Back to Collection Items
IncludeFile "CkJsonObject.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": {
; "blockInfo": [
; {
; "block": {
; "blockDetails": {
; "blockCode": "ORCLE0622",
; "blockName": "Oracle Conference 2022",
; "blockAliases": [
; ],
; "timeSpan": {
; "startDate": "2022-06-01",
; "endDate": "2022-06-02"
; },
; "shoulderDates": {},
; "blockStatus": {
; "bookingStatus": {
; "status": {
; "code": "TEN"
; }
; }
; },
; "reservationType": {
; "reservationType": "GRPGTD"
; },
; "marketCode": {
; "marketCode": "LEISURE"
; },
; "sourceOfSale": {
; "sourceCode": {
; "sourceCode": "WEB"
; }
; },
; "reservationMethod": {},
; "bookingType": {},
; "rateProtectionDetails": {
; "criteria": "None"
; },
; "nonCompeteDetails": {
; "criteria": "None"
; },
; "currencyCode": "USD",
; "blockClassification": "RegularBooking",
; "cateringOnlyBlock": false,
; "allowRateOverride": false,
; "manualCutOff": false,
; "wholesaleBlock": false,
; "controlBlockLocally": false
; },
; "blockOwners": {
; "owner": [
; {
; "ownership": "Block",
; "ownerCode": "ALL",
; "primary": true
; },
; {
; "ownership": "Catering",
; "ownerCode": "ALL",
; "primary": true
; },
; {
; "ownership": "Rooms",
; "ownerCode": "ALL",
; "primary": true
; }
; ],
; "lockBlockOwners": false,
; "lockRoomsOwners": false,
; "lockCateringOwners": false
; },
; "reservationDetails": {
; "ratePlanCode": [
; {
; "primary": true,
; "ratePlanCode": "BAR"
; }
; ],
; "traceCode": {},
; "breakfast": {
; "breakfastIncluded": false,
; "price": {
; "currencyCode": "USD"
; }
; },
; "porterage": {
; "porterageIncluded": false,
; "price": {
; "currencyCode": "USD"
; }
; },
; "elastic": "1",
; "suppressRate": false,
; "housing": true
; },
; "catering": {
; "cateringStatus": {
; "bookingStatus": {
; "status": {}
; }
; },
; "eventAttendees": {},
; "overrideEventsProcessingWarnings": true
; },
; "blockProfiles": {
; "fullOverlay": false
; },
; "blockPackages": [
; ],
; "externalAttributes": {
; "eventType": "Convention",
; "rollEndDate": false
; },
; "hotelId": "{{HotelId}}",
; "markAsRecentlyAccessed": true
; }
; }
; ]
; }
; }
json.i = CkJsonObject::ckCreate()
If json.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckUpdateString(json,"blocks.blockInfo[0].block.blockDetails.blockCode","ORCLE0622")
CkJsonObject::ckUpdateString(json,"blocks.blockInfo[0].block.blockDetails.blockName","Oracle Conference 2022")
CkJsonObject::ckUpdateNewArray(json,"blocks.blockInfo[0].block.blockDetails.blockAliases")
CkJsonObject::ckUpdateString(json,"blocks.blockInfo[0].block.blockDetails.timeSpan.startDate","2022-06-01")
CkJsonObject::ckUpdateString(json,"blocks.blockInfo[0].block.blockDetails.timeSpan.endDate","2022-06-02")
CkJsonObject::ckUpdateNewObject(json,"blocks.blockInfo[0].block.blockDetails.shoulderDates")
CkJsonObject::ckUpdateString(json,"blocks.blockInfo[0].block.blockDetails.blockStatus.bookingStatus.status.code","TEN")
CkJsonObject::ckUpdateString(json,"blocks.blockInfo[0].block.blockDetails.reservationType.reservationType","GRPGTD")
CkJsonObject::ckUpdateString(json,"blocks.blockInfo[0].block.blockDetails.marketCode.marketCode","LEISURE")
CkJsonObject::ckUpdateString(json,"blocks.blockInfo[0].block.blockDetails.sourceOfSale.sourceCode.sourceCode","WEB")
CkJsonObject::ckUpdateNewObject(json,"blocks.blockInfo[0].block.blockDetails.reservationMethod")
CkJsonObject::ckUpdateNewObject(json,"blocks.blockInfo[0].block.blockDetails.bookingType")
CkJsonObject::ckUpdateString(json,"blocks.blockInfo[0].block.blockDetails.rateProtectionDetails.criteria","None")
CkJsonObject::ckUpdateString(json,"blocks.blockInfo[0].block.blockDetails.nonCompeteDetails.criteria","None")
CkJsonObject::ckUpdateString(json,"blocks.blockInfo[0].block.blockDetails.currencyCode","USD")
CkJsonObject::ckUpdateString(json,"blocks.blockInfo[0].block.blockDetails.blockClassification","RegularBooking")
CkJsonObject::ckUpdateBool(json,"blocks.blockInfo[0].block.blockDetails.cateringOnlyBlock",0)
CkJsonObject::ckUpdateBool(json,"blocks.blockInfo[0].block.blockDetails.allowRateOverride",0)
CkJsonObject::ckUpdateBool(json,"blocks.blockInfo[0].block.blockDetails.manualCutOff",0)
CkJsonObject::ckUpdateBool(json,"blocks.blockInfo[0].block.blockDetails.wholesaleBlock",0)
CkJsonObject::ckUpdateBool(json,"blocks.blockInfo[0].block.blockDetails.controlBlockLocally",0)
CkJsonObject::ckUpdateString(json,"blocks.blockInfo[0].block.blockOwners.owner[0].ownership","Block")
CkJsonObject::ckUpdateString(json,"blocks.blockInfo[0].block.blockOwners.owner[0].ownerCode","ALL")
CkJsonObject::ckUpdateBool(json,"blocks.blockInfo[0].block.blockOwners.owner[0].primary",1)
CkJsonObject::ckUpdateString(json,"blocks.blockInfo[0].block.blockOwners.owner[1].ownership","Catering")
CkJsonObject::ckUpdateString(json,"blocks.blockInfo[0].block.blockOwners.owner[1].ownerCode","ALL")
CkJsonObject::ckUpdateBool(json,"blocks.blockInfo[0].block.blockOwners.owner[1].primary",1)
CkJsonObject::ckUpdateString(json,"blocks.blockInfo[0].block.blockOwners.owner[2].ownership","Rooms")
CkJsonObject::ckUpdateString(json,"blocks.blockInfo[0].block.blockOwners.owner[2].ownerCode","ALL")
CkJsonObject::ckUpdateBool(json,"blocks.blockInfo[0].block.blockOwners.owner[2].primary",1)
CkJsonObject::ckUpdateBool(json,"blocks.blockInfo[0].block.blockOwners.lockBlockOwners",0)
CkJsonObject::ckUpdateBool(json,"blocks.blockInfo[0].block.blockOwners.lockRoomsOwners",0)
CkJsonObject::ckUpdateBool(json,"blocks.blockInfo[0].block.blockOwners.lockCateringOwners",0)
CkJsonObject::ckUpdateBool(json,"blocks.blockInfo[0].block.reservationDetails.ratePlanCode[0].primary",1)
CkJsonObject::ckUpdateString(json,"blocks.blockInfo[0].block.reservationDetails.ratePlanCode[0].ratePlanCode","BAR")
CkJsonObject::ckUpdateNewObject(json,"blocks.blockInfo[0].block.reservationDetails.traceCode")
CkJsonObject::ckUpdateBool(json,"blocks.blockInfo[0].block.reservationDetails.breakfast.breakfastIncluded",0)
CkJsonObject::ckUpdateString(json,"blocks.blockInfo[0].block.reservationDetails.breakfast.price.currencyCode","USD")
CkJsonObject::ckUpdateBool(json,"blocks.blockInfo[0].block.reservationDetails.porterage.porterageIncluded",0)
CkJsonObject::ckUpdateString(json,"blocks.blockInfo[0].block.reservationDetails.porterage.price.currencyCode","USD")
CkJsonObject::ckUpdateString(json,"blocks.blockInfo[0].block.reservationDetails.elastic","1")
CkJsonObject::ckUpdateBool(json,"blocks.blockInfo[0].block.reservationDetails.suppressRate",0)
CkJsonObject::ckUpdateBool(json,"blocks.blockInfo[0].block.reservationDetails.housing",1)
CkJsonObject::ckUpdateNewObject(json,"blocks.blockInfo[0].block.catering.cateringStatus.bookingStatus.status")
CkJsonObject::ckUpdateNewObject(json,"blocks.blockInfo[0].block.catering.eventAttendees")
CkJsonObject::ckUpdateBool(json,"blocks.blockInfo[0].block.catering.overrideEventsProcessingWarnings",1)
CkJsonObject::ckUpdateBool(json,"blocks.blockInfo[0].block.blockProfiles.fullOverlay",0)
CkJsonObject::ckUpdateNewArray(json,"blocks.blockInfo[0].block.blockPackages")
CkJsonObject::ckUpdateString(json,"blocks.blockInfo[0].block.externalAttributes.eventType","Convention")
CkJsonObject::ckUpdateBool(json,"blocks.blockInfo[0].block.externalAttributes.rollEndDate",0)
CkJsonObject::ckUpdateString(json,"blocks.blockInfo[0].block.hotelId","{{HotelId}}")
CkJsonObject::ckUpdateBool(json,"blocks.blockInfo[0].block.markAsRecentlyAccessed",1)
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>")
resp.i = CkHttp::ckPostJson3(http,"https://domain.com/blk/v0/hotels/{{HotelId}}/block","application/json",json)
If CkHttp::ckLastMethodSuccess(http) = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
ProcedureReturn
EndIf
Debug Str(CkHttpResponse::ckStatusCode(resp))
Debug CkHttpResponse::ckBodyStr(resp)
CkHttpResponse::ckDispose(resp)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
ProcedureReturn
EndProcedure
Curl Command
curl -X POST
-H "Authorization: Bearer <access_token>"
-H "x-hotelid: {{HotelId}}"
-H "x-app-key: {{AppKey}}"
-d '{
"blocks": {
"blockInfo": [
{
"block": {
"blockDetails": {
"blockCode": "ORCLE0622",
"blockName": "Oracle Conference 2022",
"blockAliases": [],
"timeSpan": {
"startDate": "2022-06-01",
"endDate": "2022-06-02"
},
"shoulderDates": {},
"blockStatus": {
"bookingStatus": {
"status": {
"code": "TEN"
}
}
},
"reservationType": {
"reservationType": "GRPGTD"
},
"marketCode": {
"marketCode": "LEISURE"
},
"sourceOfSale": {
"sourceCode": {
"sourceCode": "WEB"
}
},
"reservationMethod": {},
"bookingType": {},
"rateProtectionDetails": {
"criteria": "None"
},
"nonCompeteDetails": {
"criteria": "None"
},
"currencyCode": "USD",
"blockClassification": "RegularBooking",
"cateringOnlyBlock": false,
"allowRateOverride": false,
"manualCutOff": false,
"wholesaleBlock": false,
"controlBlockLocally": false
},
"blockOwners": {
"owner": [
{
"ownership": "Block",
"ownerCode": "ALL",
"primary": true
},
{
"ownership": "Catering",
"ownerCode": "ALL",
"primary": true
},
{
"ownership": "Rooms",
"ownerCode": "ALL",
"primary": true
}
],
"lockBlockOwners": false,
"lockRoomsOwners": false,
"lockCateringOwners": false
},
"reservationDetails": {
"ratePlanCode": [
{
"primary": true,
"ratePlanCode": "BAR"
}
],
"traceCode": {},
"breakfast": {
"breakfastIncluded": false,
"price": {
"currencyCode": "USD"
}
},
"porterage": {
"porterageIncluded": false,
"price": {
"currencyCode": "USD"
}
},
"elastic": "1",
"suppressRate": false,
"housing": true
},
"catering": {
"cateringStatus": {
"bookingStatus": {
"status": {}
}
},
"eventAttendees": {},
"overrideEventsProcessingWarnings": true
},
"blockProfiles": {
"fullOverlay": false
},
"blockPackages": [],
"externalAttributes": {
"eventType": "Convention",
"rollEndDate": false
},
"hotelId": "{{HotelId}}",
"markAsRecentlyAccessed": true
}
}
]
}
}'
https://domain.com/blk/v0/hotels/{{HotelId}}/block
Postman Collection Item JSON
{
"name": "Create a new Block",
"event": [
{
"listen": "test",
"script": {
"exec": [
"var data = pm.response.headers.get(\"Location\").split(\"/\").pop();\r",
"postman.setEnvironmentVariable(\"BlockId\", data);"
],
"type": "text/javascript"
}
}
],
"request": {
"auth": {
"type": "bearer",
"bearer": [
{
"key": "token",
"value": "{{Token}}",
"type": "string"
}
]
},
"method": "POST",
"header": [
{
"key": "x-hotelid",
"value": "{{HotelId}}"
},
{
"key": "x-app-key",
"value": "{{AppKey}}"
}
],
"body": {
"mode": "raw",
"raw": "{\r\n \"blocks\": {\r\n \"blockInfo\": [\r\n {\r\n \"block\": {\r\n \"blockDetails\": {\r\n \"blockCode\": \"ORCLE0622\",\r\n \"blockName\": \"Oracle Conference 2022\",\r\n \"blockAliases\": [],\r\n \"timeSpan\": {\r\n \"startDate\": \"2022-06-01\",\r\n \"endDate\": \"2022-06-02\"\r\n },\r\n \"shoulderDates\": {},\r\n \"blockStatus\": {\r\n \"bookingStatus\": {\r\n \"status\": {\r\n \"code\": \"TEN\"\r\n }\r\n }\r\n },\r\n \"reservationType\": {\r\n \"reservationType\": \"GRPGTD\"\r\n },\r\n \"marketCode\": {\r\n \"marketCode\": \"LEISURE\"\r\n },\r\n \"sourceOfSale\": {\r\n \"sourceCode\": {\r\n \"sourceCode\": \"WEB\"\r\n }\r\n },\r\n \"reservationMethod\": {},\r\n \"bookingType\": {},\r\n \"rateProtectionDetails\": {\r\n \"criteria\": \"None\"\r\n },\r\n \"nonCompeteDetails\": {\r\n \"criteria\": \"None\"\r\n },\r\n \"currencyCode\": \"USD\",\r\n \"blockClassification\": \"RegularBooking\",\r\n \"cateringOnlyBlock\": false,\r\n \"allowRateOverride\": false,\r\n \"manualCutOff\": false,\r\n \"wholesaleBlock\": false,\r\n \"controlBlockLocally\": false\r\n },\r\n \"blockOwners\": {\r\n \"owner\": [\r\n {\r\n \"ownership\": \"Block\",\r\n \"ownerCode\": \"ALL\",\r\n \"primary\": true\r\n },\r\n {\r\n \"ownership\": \"Catering\",\r\n \"ownerCode\": \"ALL\",\r\n \"primary\": true\r\n },\r\n {\r\n \"ownership\": \"Rooms\",\r\n \"ownerCode\": \"ALL\",\r\n \"primary\": true\r\n }\r\n ],\r\n \"lockBlockOwners\": false,\r\n \"lockRoomsOwners\": false,\r\n \"lockCateringOwners\": false\r\n },\r\n \"reservationDetails\": {\r\n \"ratePlanCode\": [\r\n {\r\n \"primary\": true,\r\n \"ratePlanCode\": \"BAR\"\r\n }\r\n ],\r\n \"traceCode\": {},\r\n \"breakfast\": {\r\n \"breakfastIncluded\": false,\r\n \"price\": {\r\n \"currencyCode\": \"USD\"\r\n }\r\n },\r\n \"porterage\": {\r\n \"porterageIncluded\": false,\r\n \"price\": {\r\n \"currencyCode\": \"USD\"\r\n }\r\n },\r\n \"elastic\": \"1\",\r\n \"suppressRate\": false,\r\n \"housing\": true\r\n },\r\n \"catering\": {\r\n \"cateringStatus\": {\r\n \"bookingStatus\": {\r\n \"status\": {}\r\n }\r\n },\r\n \"eventAttendees\": {},\r\n \"overrideEventsProcessingWarnings\": true\r\n },\r\n \"blockProfiles\": {\r\n \"fullOverlay\": false\r\n },\r\n \"blockPackages\": [],\r\n \"externalAttributes\": {\r\n \"eventType\": \"Convention\",\r\n \"rollEndDate\": false\r\n },\r\n \"hotelId\": \"{{HotelId}}\",\r\n \"markAsRecentlyAccessed\": true\r\n }\r\n }\r\n ]\r\n }\r\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{HostName}}/blk/v0/hotels/{{HotelId}}/block",
"host": [
"{{HostName}}"
],
"path": [
"blk",
"v0",
"hotels",
"{{HotelId}}",
"block"
]
}
},
"response": [
]
}
