Back to Collection Items
-- Important: See this note about string length limitations for strings returned by sp_OAMethod calls.
--
CREATE PROCEDURE ChilkatSample
AS
BEGIN
DECLARE @hr int
DECLARE @iTmp0 int
-- Important: Do not use nvarchar(max). See the warning about using nvarchar(max).
DECLARE @sTmp0 nvarchar(4000)
-- This example assumes the Chilkat API to have been previously unlocked.
-- See Global Unlock Sample for sample code.
DECLARE @http int
-- Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.Http', @http OUT
IF @hr <> 0
BEGIN
PRINT 'Failed to create ActiveX component'
RETURN
END
DECLARE @success int
-- Use this online tool to generate code from sample JSON: Generate Code to Create JSON
-- The following JSON is sent in the request body.
-- {
-- "reservations": {
-- "reservation": [
-- {
-- "sourceOfSale": {
-- "sourceType": "PMS",
-- "sourceCode": "{{HotelId}}"
-- },
-- "roomStay": {
-- "roomRates": [
-- {
-- "total": {
-- "amountBeforeTax": "200"
-- },
-- "rates": {
-- "rate": [
-- {
-- "base": {
-- "amountBeforeTax": "200",
-- "currencyCode": "USD"
-- },
-- "shareDistributionInstruction": "Full",
-- "total": {
-- "amountBeforeTax": "200"
-- },
-- "start": "{{currentdate}}",
-- "end": "{{currentdateplus1}}"
-- }
-- ]
-- },
-- "guestCounts": {
-- "adults": "1",
-- "children": "0"
-- },
-- "roomType": "{{RoomTypeCode}}",
-- "ratePlanCode": "{{RatePlanCode}}",
-- "start": "{{currentdate}}",
-- "end": "{{currentdateplus1}}",
-- "suppressRate": true,
-- "marketCode": "LEISURE",
-- "marketCodeDescription": "Leisure",
-- "sourceCode": "PHONE",
-- "sourceCodeDescription": "Over the Phone",
-- "numberOfUnits": "1",
-- "pseudoRoom": false,
-- "roomTypeCharged": "{{RoomTypeCode}}",
-- "houseUseOnly": false,
-- "complimentary": false,
-- "fixedRate": true,
-- "discountAllowed": false,
-- "bogoDiscount": false
-- }
-- ],
-- "guestCounts": {
-- "adults": "1",
-- "children": "0"
-- },
-- "arrivalDate": "{{currentdate}}",
-- "departureDate": "{{currentdateplus1}}",
-- "guarantee": {
-- "guaranteeCode": "6PM",
-- "shortDescription": "6PM Hold"
-- },
-- "roomNumberLocked": false,
-- "printRate": false
-- },
-- "reservationGuests": [
-- {
-- "profileInfo": {
-- "profile": {
-- "customer": {
-- "personName": [
-- {
-- "givenName": "Jane",
-- "surname": "Smith",
-- "nameType": "Primary"
-- },
-- {
-- "nameType": "External"
-- }
-- ],
-- "language": "E"
-- },
-- "profileType": "Guest"
-- }
-- },
-- "primary": true
-- }
-- ],
-- "reservationPaymentMethods": [
-- {
-- "paymentMethod": "CA",
-- "folioView": "1"
-- }
-- ],
-- "comments": [
-- {
-- "comment": {
-- "text": {
-- "value": "Please ensure I have tea in my room"
-- },
-- "commentTitle": "General Notes",
-- "notificationLocation": "RESERVATION",
-- "type": "GEN",
-- "internal": false
-- }
-- }
-- ],
-- "hotelId": "{{HotelId}}",
-- "roomStayReservation": true,
-- "reservationStatus": "Reserved",
-- "computedReservationStatus": "DueIn",
-- "walkIn": false,
-- "printRate": false,
-- "preRegistered": false,
-- "upgradeEligible": false,
-- "allowAutoCheckin": false,
-- "hasOpenFolio": false,
-- "allowMobileCheckout": false,
-- "allowMobileViewFolio": false,
-- "allowPreRegistration": false,
-- "optedForCommunication": false
-- }
-- ]
-- }
-- }
DECLARE @json int
-- Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @json OUT
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'reservations.reservation[0].sourceOfSale.sourceType', 'PMS'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'reservations.reservation[0].sourceOfSale.sourceCode', '{{HotelId}}'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'reservations.reservation[0].roomStay.roomRates[0].total.amountBeforeTax', '200'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'reservations.reservation[0].roomStay.roomRates[0].rates.rate[0].base.amountBeforeTax', '200'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'reservations.reservation[0].roomStay.roomRates[0].rates.rate[0].base.currencyCode', 'USD'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'reservations.reservation[0].roomStay.roomRates[0].rates.rate[0].shareDistributionInstruction', 'Full'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'reservations.reservation[0].roomStay.roomRates[0].rates.rate[0].total.amountBeforeTax', '200'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'reservations.reservation[0].roomStay.roomRates[0].rates.rate[0].start', '{{currentdate}}'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'reservations.reservation[0].roomStay.roomRates[0].rates.rate[0].end', '{{currentdateplus1}}'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'reservations.reservation[0].roomStay.roomRates[0].guestCounts.adults', '1'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'reservations.reservation[0].roomStay.roomRates[0].guestCounts.children', '0'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'reservations.reservation[0].roomStay.roomRates[0].roomType', '{{RoomTypeCode}}'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'reservations.reservation[0].roomStay.roomRates[0].ratePlanCode', '{{RatePlanCode}}'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'reservations.reservation[0].roomStay.roomRates[0].start', '{{currentdate}}'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'reservations.reservation[0].roomStay.roomRates[0].end', '{{currentdateplus1}}'
EXEC sp_OAMethod @json, 'UpdateBool', @success OUT, 'reservations.reservation[0].roomStay.roomRates[0].suppressRate', 1
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'reservations.reservation[0].roomStay.roomRates[0].marketCode', 'LEISURE'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'reservations.reservation[0].roomStay.roomRates[0].marketCodeDescription', 'Leisure'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'reservations.reservation[0].roomStay.roomRates[0].sourceCode', 'PHONE'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'reservations.reservation[0].roomStay.roomRates[0].sourceCodeDescription', 'Over the Phone'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'reservations.reservation[0].roomStay.roomRates[0].numberOfUnits', '1'
EXEC sp_OAMethod @json, 'UpdateBool', @success OUT, 'reservations.reservation[0].roomStay.roomRates[0].pseudoRoom', 0
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'reservations.reservation[0].roomStay.roomRates[0].roomTypeCharged', '{{RoomTypeCode}}'
EXEC sp_OAMethod @json, 'UpdateBool', @success OUT, 'reservations.reservation[0].roomStay.roomRates[0].houseUseOnly', 0
EXEC sp_OAMethod @json, 'UpdateBool', @success OUT, 'reservations.reservation[0].roomStay.roomRates[0].complimentary', 0
EXEC sp_OAMethod @json, 'UpdateBool', @success OUT, 'reservations.reservation[0].roomStay.roomRates[0].fixedRate', 1
EXEC sp_OAMethod @json, 'UpdateBool', @success OUT, 'reservations.reservation[0].roomStay.roomRates[0].discountAllowed', 0
EXEC sp_OAMethod @json, 'UpdateBool', @success OUT, 'reservations.reservation[0].roomStay.roomRates[0].bogoDiscount', 0
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'reservations.reservation[0].roomStay.guestCounts.adults', '1'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'reservations.reservation[0].roomStay.guestCounts.children', '0'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'reservations.reservation[0].roomStay.arrivalDate', '{{currentdate}}'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'reservations.reservation[0].roomStay.departureDate', '{{currentdateplus1}}'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'reservations.reservation[0].roomStay.guarantee.guaranteeCode', '6PM'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'reservations.reservation[0].roomStay.guarantee.shortDescription', '6PM Hold'
EXEC sp_OAMethod @json, 'UpdateBool', @success OUT, 'reservations.reservation[0].roomStay.roomNumberLocked', 0
EXEC sp_OAMethod @json, 'UpdateBool', @success OUT, 'reservations.reservation[0].roomStay.printRate', 0
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'reservations.reservation[0].reservationGuests[0].profileInfo.profile.customer.personName[0].givenName', 'Jane'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'reservations.reservation[0].reservationGuests[0].profileInfo.profile.customer.personName[0].surname', 'Smith'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'reservations.reservation[0].reservationGuests[0].profileInfo.profile.customer.personName[0].nameType', 'Primary'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'reservations.reservation[0].reservationGuests[0].profileInfo.profile.customer.personName[1].nameType', 'External'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'reservations.reservation[0].reservationGuests[0].profileInfo.profile.customer.language', 'E'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'reservations.reservation[0].reservationGuests[0].profileInfo.profile.profileType', 'Guest'
EXEC sp_OAMethod @json, 'UpdateBool', @success OUT, 'reservations.reservation[0].reservationGuests[0].primary', 1
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'reservations.reservation[0].reservationPaymentMethods[0].paymentMethod', 'CA'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'reservations.reservation[0].reservationPaymentMethods[0].folioView', '1'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'reservations.reservation[0].comments[0].comment.text.value', 'Please ensure I have tea in my room'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'reservations.reservation[0].comments[0].comment.commentTitle', 'General Notes'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'reservations.reservation[0].comments[0].comment.notificationLocation', 'RESERVATION'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'reservations.reservation[0].comments[0].comment.type', 'GEN'
EXEC sp_OAMethod @json, 'UpdateBool', @success OUT, 'reservations.reservation[0].comments[0].comment.internal', 0
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'reservations.reservation[0].hotelId', '{{HotelId}}'
EXEC sp_OAMethod @json, 'UpdateBool', @success OUT, 'reservations.reservation[0].roomStayReservation', 1
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'reservations.reservation[0].reservationStatus', 'Reserved'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'reservations.reservation[0].computedReservationStatus', 'DueIn'
EXEC sp_OAMethod @json, 'UpdateBool', @success OUT, 'reservations.reservation[0].walkIn', 0
EXEC sp_OAMethod @json, 'UpdateBool', @success OUT, 'reservations.reservation[0].printRate', 0
EXEC sp_OAMethod @json, 'UpdateBool', @success OUT, 'reservations.reservation[0].preRegistered', 0
EXEC sp_OAMethod @json, 'UpdateBool', @success OUT, 'reservations.reservation[0].upgradeEligible', 0
EXEC sp_OAMethod @json, 'UpdateBool', @success OUT, 'reservations.reservation[0].allowAutoCheckin', 0
EXEC sp_OAMethod @json, 'UpdateBool', @success OUT, 'reservations.reservation[0].hasOpenFolio', 0
EXEC sp_OAMethod @json, 'UpdateBool', @success OUT, 'reservations.reservation[0].allowMobileCheckout', 0
EXEC sp_OAMethod @json, 'UpdateBool', @success OUT, 'reservations.reservation[0].allowMobileViewFolio', 0
EXEC sp_OAMethod @json, 'UpdateBool', @success OUT, 'reservations.reservation[0].allowPreRegistration', 0
EXEC sp_OAMethod @json, 'UpdateBool', @success OUT, 'reservations.reservation[0].optedForCommunication', 0
EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'Content-Type', 'application/json'
EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'x-hotelid', '{{HotelId}}'
-- Adds the "Authorization: Bearer <access_token>" header.
EXEC sp_OASetProperty @http, 'AuthToken', '<access_token>'
EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'x-app-key', '{{AppKey}}'
DECLARE @resp int
EXEC sp_OAMethod @http, 'PostJson3', @resp OUT, 'https://domain.com/rsv/v1/hotels/{{HotelId}}/reservations/', 'application/json', @json
EXEC sp_OAGetProperty @http, 'LastMethodSuccess', @iTmp0 OUT
IF @iTmp0 = 0
BEGIN
EXEC sp_OAGetProperty @http, 'LastErrorText', @sTmp0 OUT
PRINT @sTmp0
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @json
RETURN
END
EXEC sp_OAGetProperty @resp, 'StatusCode', @iTmp0 OUT
PRINT @iTmp0
EXEC sp_OAGetProperty @resp, 'BodyStr', @sTmp0 OUT
PRINT @sTmp0
EXEC @hr = sp_OADestroy @resp
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @json
END
GO
Curl Command
curl -X POST
-H "Authorization: Bearer <access_token>"
-H "Content-Type: application/json"
-H "x-hotelid: {{HotelId}}"
-H "x-app-key: {{AppKey}}"
-d '{
"reservations": {
"reservation": [
{
"sourceOfSale": {
"sourceType": "PMS",
"sourceCode": "{{HotelId}}"
},
"roomStay": {
"roomRates": [
{
"total": {
"amountBeforeTax": "200"
},
"rates": {
"rate": [
{
"base": {
"amountBeforeTax": "200",
"currencyCode": "USD"
},
"shareDistributionInstruction": "Full",
"total": {
"amountBeforeTax": "200"
},
"start": "{{currentdate}}",
"end": "{{currentdateplus1}}"
}
]
},
"guestCounts": {
"adults": "1",
"children": "0"
},
"roomType": "{{RoomTypeCode}}",
"ratePlanCode": "{{RatePlanCode}}",
"start": "{{currentdate}}",
"end": "{{currentdateplus1}}",
"suppressRate": true,
"marketCode": "LEISURE",
"marketCodeDescription": "Leisure",
"sourceCode": "PHONE",
"sourceCodeDescription": "Over the Phone",
"numberOfUnits": "1",
"pseudoRoom": false,
"roomTypeCharged": "{{RoomTypeCode}}",
"houseUseOnly": false,
"complimentary": false,
"fixedRate": true,
"discountAllowed": false,
"bogoDiscount": false
}
],
"guestCounts": {
"adults": "1",
"children": "0"
},
"arrivalDate": "{{currentdate}}",
"departureDate": "{{currentdateplus1}}",
"guarantee": {
"guaranteeCode": "6PM",
"shortDescription": "6PM Hold"
},
"roomNumberLocked": false,
"printRate": false
},
"reservationGuests": [
{
"profileInfo": {
"profile": {
"customer": {
"personName": [
{
"givenName": "Jane",
"surname": "Smith",
"nameType": "Primary"
},
{
"nameType": "External"
}
],
"language": "E"
},
"profileType": "Guest"
}
},
"primary": true
}
],
"reservationPaymentMethods": [
{
"paymentMethod": "CA",
"folioView": "1"
}
],
"comments": [
{
"comment": {
"text": {
"value": "Please ensure I have tea in my room"
},
"commentTitle": "General Notes",
"notificationLocation": "RESERVATION",
"type": "GEN",
"internal": false
}
}
],
"hotelId": "{{HotelId}}",
"roomStayReservation": true,
"reservationStatus": "Reserved",
"computedReservationStatus": "DueIn",
"walkIn": false,
"printRate": false,
"preRegistered": false,
"upgradeEligible": false,
"allowAutoCheckin": false,
"hasOpenFolio": false,
"allowMobileCheckout": false,
"allowMobileViewFolio": false,
"allowPreRegistration": false,
"optedForCommunication": false
}
]
}
}'
https://domain.com/rsv/v1/hotels/{{HotelId}}/reservations/
Postman Collection Item JSON
{
"name": "Create a new reservation",
"event": [
{
"listen": "test",
"script": {
"exec": [
"var data = pm.response.headers.get(\"Location\").split(\"/\").pop();\r",
"postman.setEnvironmentVariable(\"ReservationId\", data);"
],
"type": "text/javascript"
}
}
],
"request": {
"auth": {
"type": "bearer",
"bearer": [
{
"key": "token",
"value": "{{Token}}",
"type": "string"
}
]
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"name": "Content-Type",
"type": "text",
"value": "application/json"
},
{
"key": "x-hotelid",
"type": "text",
"value": "{{HotelId}}"
},
{
"key": "x-app-key",
"value": "{{AppKey}}",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\r\n \"reservations\": {\r\n \"reservation\": [\r\n {\r\n \"sourceOfSale\": {\r\n \"sourceType\": \"PMS\",\r\n \"sourceCode\": \"{{HotelId}}\"\r\n },\r\n \"roomStay\": {\r\n \"roomRates\": [\r\n {\r\n \"total\": {\r\n \"amountBeforeTax\": \"200\"\r\n },\r\n \"rates\": {\r\n \"rate\": [\r\n {\r\n \"base\": {\r\n \"amountBeforeTax\": \"200\",\r\n \"currencyCode\": \"USD\"\r\n },\r\n \"shareDistributionInstruction\": \"Full\",\r\n \"total\": {\r\n \"amountBeforeTax\": \"200\"\r\n },\r\n \"start\": \"{{currentdate}}\",\r\n \"end\": \"{{currentdateplus1}}\"\r\n }\r\n ]\r\n },\r\n \"guestCounts\": {\r\n \"adults\": \"1\",\r\n \"children\": \"0\"\r\n },\r\n \"roomType\": \"{{RoomTypeCode}}\",\r\n \"ratePlanCode\": \"{{RatePlanCode}}\",\r\n \"start\": \"{{currentdate}}\",\r\n \"end\": \"{{currentdateplus1}}\",\r\n \"suppressRate\": true,\r\n \"marketCode\": \"LEISURE\",\r\n \"marketCodeDescription\": \"Leisure\",\r\n \"sourceCode\": \"PHONE\",\r\n \"sourceCodeDescription\": \"Over the Phone\",\r\n \"numberOfUnits\": \"1\",\r\n \"pseudoRoom\": false,\r\n \"roomTypeCharged\": \"{{RoomTypeCode}}\",\r\n \"houseUseOnly\": false,\r\n \"complimentary\": false,\r\n \"fixedRate\": true,\r\n \"discountAllowed\": false,\r\n \"bogoDiscount\": false\r\n }\r\n ],\r\n \"guestCounts\": {\r\n \"adults\": \"1\",\r\n \"children\": \"0\"\r\n },\r\n \"arrivalDate\": \"{{currentdate}}\",\r\n \"departureDate\": \"{{currentdateplus1}}\",\r\n \"guarantee\": {\r\n \"guaranteeCode\": \"6PM\",\r\n \"shortDescription\": \"6PM Hold\"\r\n },\r\n \"roomNumberLocked\": false,\r\n \"printRate\": false\r\n },\r\n \"reservationGuests\": [\r\n {\r\n \"profileInfo\": {\r\n \"profile\": {\r\n \"customer\": {\r\n \"personName\": [\r\n {\r\n \"givenName\": \"Jane\",\r\n \"surname\": \"Smith\",\r\n \"nameType\": \"Primary\"\r\n },\r\n {\r\n \"nameType\": \"External\"\r\n }\r\n ],\r\n \"language\": \"E\"\r\n },\r\n \"profileType\": \"Guest\"\r\n }\r\n },\r\n \"primary\": true\r\n }\r\n ],\r\n \"reservationPaymentMethods\": [\r\n {\r\n \"paymentMethod\": \"CA\",\r\n \"folioView\": \"1\"\r\n }\r\n ],\r\n \"comments\": [\r\n {\r\n \"comment\": {\r\n \"text\": {\r\n \"value\": \"Please ensure I have tea in my room\"\r\n },\r\n \"commentTitle\": \"General Notes\",\r\n \"notificationLocation\": \"RESERVATION\",\r\n \"type\": \"GEN\",\r\n \"internal\": false\r\n }\r\n }\r\n ],\r\n \"hotelId\": \"{{HotelId}}\",\r\n \"roomStayReservation\": true,\r\n \"reservationStatus\": \"Reserved\",\r\n \"computedReservationStatus\": \"DueIn\",\r\n \"walkIn\": false,\r\n \"printRate\": false,\r\n \"preRegistered\": false,\r\n \"upgradeEligible\": false,\r\n \"allowAutoCheckin\": false,\r\n \"hasOpenFolio\": false,\r\n \"allowMobileCheckout\": false,\r\n \"allowMobileViewFolio\": false,\r\n \"allowPreRegistration\": false,\r\n \"optedForCommunication\": false\r\n }\r\n ]\r\n }\r\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{HostName}}/rsv/v1/hotels/{{HotelId}}/reservations/",
"host": [
"{{HostName}}"
],
"path": [
"rsv",
"v1",
"hotels",
"{{HotelId}}",
"reservations",
""
]
}
},
"response": [
]
}
