Chilkat Online Tools

Objective-C / ORACLE Hospitality OPERA Cloud REST API Workflows / Check out a reservation

Back to Collection Items

#import <CkoHttp.h>
#import <CkoJsonObject.h>
#import <CkoHttpResponse.h>

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

CkoHttp *http = [[CkoHttp alloc] init];
BOOL success;

// 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": 4,
//     "hotelId": "{{HotelId}}",
//     "eventType": "CheckOut",
//     "autoCheckout": false,
//     "checkoutInstr": {
//       "roomStatus": "Dirty",
//       "ignoreWarnings": true
//     }
//   },
//   "verificationOnly": false
// }

CkoJsonObject *json = [[CkoJsonObject alloc] init];
[json UpdateInt: @"reservation.reservationIdList.id" value: [NSNumber numberWithInt: 123]];
[json UpdateString: @"reservation.reservationIdList.type" value: @"Reservation"];
[json UpdateBool: @"reservation.stopCheckout" value: NO];
[json UpdateInt: @"reservation.cashierId" value: [NSNumber numberWithInt: 4]];
[json UpdateString: @"reservation.hotelId" value: @"{{HotelId}}"];
[json UpdateString: @"reservation.eventType" value: @"CheckOut"];
[json UpdateBool: @"reservation.autoCheckout" value: NO];
[json UpdateString: @"reservation.checkoutInstr.roomStatus" value: @"Dirty"];
[json UpdateBool: @"reservation.checkoutInstr.ignoreWarnings" value: YES];
[json UpdateBool: @"verificationOnly" value: NO];

[http SetRequestHeader: @"Content-Type" value: @"application/json"];
[http SetRequestHeader: @"x-hotelid" value: @"{{HotelId}}"];
// Adds the "Authorization: Bearer <access_token>" header.
http.AuthToken = @"<access_token>";
[http SetRequestHeader: @"x-app-key" value: @"{{AppKey}}"];

CkoHttpResponse *resp = [http PostJson3: @"https://domain.com/csh/v0/hotels/{{HotelId}}/reservations/{{ReservationId}}/checkOuts" contentType: @"application/json" json: json];
if (http.LastMethodSuccess == NO) {
    NSLog(@"%@",http.LastErrorText);
    return;
}

NSLog(@"%d",[resp.StatusCode intValue]);
NSLog(@"%@",resp.BodyStr);

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": 4,
        "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": "Check out a reservation",
  "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\": 4,\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": [
  ]
}