Chilkat Online Tools

Foxpro / ORACLE Hospitality OPERA Cloud REST API Workflows / 14. Check-Out - putReservation (add departure time)

Back to Collection Items

LOCAL loHttp
LOCAL lnSuccess
LOCAL loJson
LOCAL loSbRequestBody
LOCAL loResp

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

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.Http')
loHttp = CreateObject('Chilkat.Http')

* 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": [
*     {
*       "reservationIdList": [
*         {
*           "type": "Reservation",
*           "id": "{{ReservationId}}"
*         }
*       ],
*       "roomStay": {
*         "arrivalDate": "2021-03-23",
*         "departureDate": "2021-03-23",
*         "expectedTimes": {
*           "reservationExpectedArrivalTime": "2021-03-23 13:00:00.0",
*           "reservationExpectedDepartureTime": "2021-03-23 10:00:00.0"
*         }
*       },
*       "hotelId": "{{HotelId}}",
*       "customReference": "",
*       "preRegistered": false,
*       "allowMobileCheckout": false
*     }
*   ]
* }

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJson = CreateObject('Chilkat.JsonObject')
loJson.UpdateString("reservations[0].reservationIdList[0].type","Reservation")
loJson.UpdateString("reservations[0].reservationIdList[0].id","{{ReservationId}}")
loJson.UpdateString("reservations[0].roomStay.arrivalDate","2021-03-23")
loJson.UpdateString("reservations[0].roomStay.departureDate","2021-03-23")
loJson.UpdateString("reservations[0].roomStay.expectedTimes.reservationExpectedArrivalTime","2021-03-23 13:00:00.0")
loJson.UpdateString("reservations[0].roomStay.expectedTimes.reservationExpectedDepartureTime","2021-03-23 10:00:00.0")
loJson.UpdateString("reservations[0].hotelId","{{HotelId}}")
loJson.UpdateString("reservations[0].customReference","")
loJson.UpdateBool("reservations[0].preRegistered",0)
loJson.UpdateBool("reservations[0].allowMobileCheckout",0)

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

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.StringBuilder')
loSbRequestBody = CreateObject('Chilkat.StringBuilder')
loJson.EmitSb(loSbRequestBody)

loResp = loHttp.PTextSb("PUT","https://domain.com/rsv/v1/hotels/{{HotelId}}/reservations/{{ReservationId}}",loSbRequestBody,"utf-8","application/json",0,0)
IF (loHttp.LastMethodSuccess = 0) THEN
    ? loHttp.LastErrorText
    RELEASE loHttp
    RELEASE loJson
    RELEASE loSbRequestBody
    CANCEL
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 "Content-Type: application/json"
	-H "x-hotelid: {{HotelId}}"
	-H "x-app-key: {{AppKey}}"
	-d '{
    "reservations": [
        {
            "reservationIdList": [
                {
                    "type": "Reservation",
                    "id": "{{ReservationId}}"
                }
            ],
            "roomStay": {
                "arrivalDate": "2021-03-23",
                "departureDate": "2021-03-23",
                "expectedTimes": {
                    "reservationExpectedArrivalTime": "2021-03-23 13:00:00.0",
                    "reservationExpectedDepartureTime": "2021-03-23 10:00:00.0"
                }
            },
            "hotelId": "{{HotelId}}",
            "customReference": "",
            "preRegistered": false,
            "allowMobileCheckout": false
        }
    ]
}'
https://domain.com/rsv/v1/hotels/{{HotelId}}/reservations/{{ReservationId}}

Postman Collection Item JSON

{
  "name": "14. Check-Out - putReservation (add departure time)",
  "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",
        "value": "{{HotelId}}",
        "type": "text"
      },
      {
        "key": "x-app-key",
        "value": "{{AppKey}}",
        "type": "text"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\r\n    \"reservations\": [\r\n        {\r\n            \"reservationIdList\": [\r\n                {\r\n                    \"type\": \"Reservation\",\r\n                    \"id\": \"{{ReservationId}}\"\r\n                }\r\n            ],\r\n            \"roomStay\": {\r\n                \"arrivalDate\": \"2021-03-23\",\r\n                \"departureDate\": \"2021-03-23\",\r\n                \"expectedTimes\": {\r\n                    \"reservationExpectedArrivalTime\": \"2021-03-23 13:00:00.0\",\r\n                    \"reservationExpectedDepartureTime\": \"2021-03-23 10:00:00.0\"\r\n                }\r\n            },\r\n            \"hotelId\": \"{{HotelId}}\",\r\n            \"customReference\": \"\",\r\n            \"preRegistered\": false,\r\n            \"allowMobileCheckout\": false\r\n        }\r\n    ]\r\n}",
      "options": {
        "raw": {
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "{{HostName}}/rsv/v1/hotels/{{HotelId}}/reservations/{{ReservationId}}",
      "host": [
        "{{HostName}}"
      ],
      "path": [
        "rsv",
        "v1",
        "hotels",
        "{{HotelId}}",
        "reservations",
        "{{ReservationId}}"
      ]
    },
    "description": "A reservation must have $0 balance, and be in 'Due-out' status to be able to check out."
  },
  "response": [
  ]
}