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.
-- {
-- "criteria": {
-- "hotelId": "{{HotelId}}",
-- "reservationIdList": [
-- {
-- "id": "{{ReservationId}}",
-- "type": "Reservation"
-- }
-- ],
-- "roomId": "{{RoomId}}",
-- "overrideInstructions": {
-- "dirtyRoom": true,
-- "outOfServiceRoom": false,
-- "sleepDiscrepantRoom": true,
-- "occupancyRestriction": false,
-- "rateRestriction": false,
-- "inventoryRestriction": false,
-- "roomNumberLocked": false,
-- "holdRoom": false,
-- "overrideExternalChecks": false,
-- "dayUseReserved": false
-- },
-- "updateRoomTypeCharged": true,
-- "includeDepartureRooms": true,
-- "roomNumberLocked": false,
-- "oldRoomStatus": "Dirty",
-- "reasonCode": "NSE",
-- "description": "Noise Complaint"
-- }
-- }
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, 'criteria.hotelId', '{{HotelId}}'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'criteria.reservationIdList[0].id', '{{ReservationId}}'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'criteria.reservationIdList[0].type', 'Reservation'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'criteria.roomId', '{{RoomId}}'
EXEC sp_OAMethod @json, 'UpdateBool', @success OUT, 'criteria.overrideInstructions.dirtyRoom', 1
EXEC sp_OAMethod @json, 'UpdateBool', @success OUT, 'criteria.overrideInstructions.outOfServiceRoom', 0
EXEC sp_OAMethod @json, 'UpdateBool', @success OUT, 'criteria.overrideInstructions.sleepDiscrepantRoom', 1
EXEC sp_OAMethod @json, 'UpdateBool', @success OUT, 'criteria.overrideInstructions.occupancyRestriction', 0
EXEC sp_OAMethod @json, 'UpdateBool', @success OUT, 'criteria.overrideInstructions.rateRestriction', 0
EXEC sp_OAMethod @json, 'UpdateBool', @success OUT, 'criteria.overrideInstructions.inventoryRestriction', 0
EXEC sp_OAMethod @json, 'UpdateBool', @success OUT, 'criteria.overrideInstructions.roomNumberLocked', 0
EXEC sp_OAMethod @json, 'UpdateBool', @success OUT, 'criteria.overrideInstructions.holdRoom', 0
EXEC sp_OAMethod @json, 'UpdateBool', @success OUT, 'criteria.overrideInstructions.overrideExternalChecks', 0
EXEC sp_OAMethod @json, 'UpdateBool', @success OUT, 'criteria.overrideInstructions.dayUseReserved', 0
EXEC sp_OAMethod @json, 'UpdateBool', @success OUT, 'criteria.updateRoomTypeCharged', 1
EXEC sp_OAMethod @json, 'UpdateBool', @success OUT, 'criteria.includeDepartureRooms', 1
EXEC sp_OAMethod @json, 'UpdateBool', @success OUT, 'criteria.roomNumberLocked', 0
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'criteria.oldRoomStatus', 'Dirty'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'criteria.reasonCode', 'NSE'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'criteria.description', 'Noise Complaint'
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 @sbRequestBody int
-- Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.StringBuilder', @sbRequestBody OUT
EXEC sp_OAMethod @json, 'EmitSb', @success OUT, @sbRequestBody
DECLARE @resp int
EXEC sp_OAMethod @http, 'PTextSb', @resp OUT, 'PUT', 'https://domain.com/fof/v0/hotels/{{HotelId}}/reservations/{{ReservationId}}/rooms/{{RoomId}}/roomMoves', @sbRequestBody, 'utf-8', 'application/json', 0, 0
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
EXEC @hr = sp_OADestroy @sbRequestBody
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
EXEC @hr = sp_OADestroy @sbRequestBody
END
GO
Curl Command
curl -X PUT
-H "Authorization: Bearer <access_token>"
-H "Content-Type: application/json"
-H "x-hotelid: {{HotelId}}"
-H "x-app-key: {{AppKey}}"
-d '{
"criteria": {
"hotelId": "{{HotelId}}",
"reservationIdList": [
{
"id": "{{ReservationId}}",
"type": "Reservation"
}
],
"roomId": "{{RoomId}}",
"overrideInstructions": {
"dirtyRoom": true,
"outOfServiceRoom": false,
"sleepDiscrepantRoom": true,
"occupancyRestriction": false,
"rateRestriction": false,
"inventoryRestriction": false,
"roomNumberLocked": false,
"holdRoom": false,
"overrideExternalChecks": false,
"dayUseReserved": false
},
"updateRoomTypeCharged": true,
"includeDepartureRooms": true,
"roomNumberLocked": false,
"oldRoomStatus": "Dirty",
"reasonCode": "NSE",
"description": "Noise Complaint"
}
}'
https://domain.com/fof/v0/hotels/{{HotelId}}/reservations/{{ReservationId}}/rooms/{{RoomId}}/roomMoves
Postman Collection Item JSON
{
"name": "Move an in-house guest to a new room",
"request": {
"auth": {
"type": "bearer",
"bearer": [
{
"key": "token",
"value": "{{Token}}",
"type": "string"
}
]
},
"method": "PUT",
"header": [
{
"key": "Content-Type",
"name": "Content-Type",
"type": "text",
"value": "application/json"
},
{
"key": "x-hotelid",
"type": "text",
"value": "{{HotelId}}"
},
{
"key": "x-app-key",
"type": "text",
"value": "{{AppKey}}"
}
],
"body": {
"mode": "raw",
"raw": "{\r\n \"criteria\": {\r\n \"hotelId\": \"{{HotelId}}\",\r\n \"reservationIdList\": [\r\n {\r\n \"id\": \"{{ReservationId}}\",\r\n \"type\": \"Reservation\"\r\n }\r\n ],\r\n \"roomId\": \"{{RoomId}}\",\r\n \"overrideInstructions\": {\r\n \"dirtyRoom\": true,\r\n \"outOfServiceRoom\": false,\r\n \"sleepDiscrepantRoom\": true,\r\n \"occupancyRestriction\": false,\r\n \"rateRestriction\": false,\r\n \"inventoryRestriction\": false,\r\n \"roomNumberLocked\": false,\r\n \"holdRoom\": false,\r\n \"overrideExternalChecks\": false,\r\n \"dayUseReserved\": false\r\n },\r\n \"updateRoomTypeCharged\": true,\r\n \"includeDepartureRooms\": true,\r\n \"roomNumberLocked\": false,\r\n \"oldRoomStatus\": \"Dirty\",\r\n \"reasonCode\": \"NSE\",\r\n \"description\": \"Noise Complaint\"\r\n }\r\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{HostName}}/fof/v0/hotels/{{HotelId}}/reservations/{{ReservationId}}/rooms/{{RoomId}}/roomMoves",
"host": [
"{{HostName}}"
],
"path": [
"fof",
"v0",
"hotels",
"{{HotelId}}",
"reservations",
"{{ReservationId}}",
"rooms",
"{{RoomId}}",
"roomMoves"
]
},
"description": "The target room is in the path and the original room is in the body"
},
"response": [
]
}
