Chilkat Online Tools

Foxpro / ORACLE Hospitality OPERA Cloud REST API Workflows / 16. Check-Out - postCheckout

Back to Collection Items

LOCAL loHttp
LOCAL lnSuccess
LOCAL loJson
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.

* {
*   "reservation": {
*     "reservationIdList": {
*       "id": 123,
*       "type": "Reservation"
*     },
*     "stopCheckout": false,
*     "cashierId": 3,
*     "hotelId": "{{HotelId}}",
*     "eventType": "CheckOut",
*     "autoCheckout": false,
*     "checkoutInstr": {
*       "roomStatus": "Dirty",
*       "ignoreWarnings": true
*     }
*   },
*   "verificationOnly": false
* }

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJson = CreateObject('Chilkat.JsonObject')
loJson.UpdateInt("reservation.reservationIdList.id",123)
loJson.UpdateString("reservation.reservationIdList.type","Reservation")
loJson.UpdateBool("reservation.stopCheckout",0)
loJson.UpdateInt("reservation.cashierId",3)
loJson.UpdateString("reservation.hotelId","{{HotelId}}")
loJson.UpdateString("reservation.eventType","CheckOut")
loJson.UpdateBool("reservation.autoCheckout",0)
loJson.UpdateString("reservation.checkoutInstr.roomStatus","Dirty")
loJson.UpdateBool("reservation.checkoutInstr.ignoreWarnings",1)
loJson.UpdateBool("verificationOnly",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}}")

loResp = loHttp.PostJson3("https://domain.com/csh/v0/hotels/{{HotelId}}/reservations/{{ReservationId}}/checkOuts","application/json",loJson)
IF (loHttp.LastMethodSuccess = 0) THEN
    ? loHttp.LastErrorText
    RELEASE loHttp
    RELEASE loJson
    CANCEL
ENDIF

? STR(loResp.StatusCode)
? loResp.BodyStr
RELEASE loResp

RELEASE loHttp
RELEASE loJson

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 '{
  "reservation": {
    "reservationIdList": {
      "id": {{ReservationId}},
      "type": "Reservation"
    },
    "stopCheckout": false,
    "cashierId": 3,
    "hotelId": "{{HotelId}}",
    "eventType": "CheckOut",
    "autoCheckout": false,
    "checkoutInstr": {
      "roomStatus": "Dirty",
      "ignoreWarnings": true
    }
  },
  "verificationOnly": false
}'
https://domain.com/csh/v0/hotels/{{HotelId}}/reservations/{{ReservationId}}/checkOuts

Postman Collection Item JSON

{
  "name": "16. Check-Out - postCheckout",
  "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  \"reservation\": {\r\n    \"reservationIdList\": {\r\n      \"id\": {{ReservationId}},\r\n      \"type\": \"Reservation\"\r\n    },\r\n    \"stopCheckout\": false,\r\n    \"cashierId\": 3,\r\n    \"hotelId\": \"{{HotelId}}\",\r\n    \"eventType\": \"CheckOut\",\r\n    \"autoCheckout\": false,\r\n    \"checkoutInstr\": {\r\n      \"roomStatus\": \"Dirty\",\r\n      \"ignoreWarnings\": true\r\n    }\r\n  },\r\n  \"verificationOnly\": false\r\n}",
      "options": {
        "raw": {
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "{{HostName}}/csh/v0/hotels/{{HotelId}}/reservations/{{ReservationId}}/checkOuts",
      "host": [
        "{{HostName}}"
      ],
      "path": [
        "csh",
        "v0",
        "hotels",
        "{{HotelId}}",
        "reservations",
        "{{ReservationId}}",
        "checkOuts"
      ]
    }
  },
  "response": [
  ]
}