Chilkat Online Tools

Ruby / ORACLE Hospitality OPERA Cloud REST API Workflows / Create a new reservation with a package

Back to Collection Items

require 'chilkat'

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

http = Chilkat::CkHttp.new()

# 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": {
#       "reservationGuests": {
#         "profileInfo": {
#           "profileIdList": {
#             "id": 123,
#             "type": "Profile"
#           }
#         }
#       },
#       "reservationPaymentMethods": {
#         "paymentMethod": "CA"
#       },
#       "markAsRecentlyAccessed": true,
#       "hotelId": "{{HotelId}}",
#       "reservationStatus": "Reserved",
#       "reservationPackages": {
#         "packageHeaderType": {
#           "transactionDetails": {
#             "calculationRule": "F",
#             "allowance": false,
#             "currency": "USD",
#             "postingType": "D"
#           },
#           "postingAttributes": {
#             "addToRate": false,
#             "printSeparateLine": true,
#             "forecastNextDay": false
#           }
#         },
#         "scheduleList": {
#           "consumptionDate": "{{currentdate}}",
#           "unitPrice": 2,
#           "originalUnitPrice": 2,
#           "unitAllowance": 0,
#           "originalUnitAllowance": 0,
#           "reservationDate": "{{currentdate}}"
#         },
#         "endDate": "{{currentdateplus1}}",
#         "packageCode": "CHAMP",
#         "source": "Reservation",
#         "startDate": "{{currentdate}}"
#       },
#       "roomStay": {
#         "guarantee": {
#           "onHold": false,
#           "guaranteeCode": "6PM"
#         },
#         "roomRates": {
#           "sourceCode": "PHONE",
#           "numberOfUnits": 1,
#           "rates": {
#             "rate": {
#               "start": "2021-07-03",
#               "end": "2021-07-03",
#               "base": {
#                 "amountBeforeTax": 50,
#                 "currencyCode": "USD"
#               }
#             }
#           },
#           "start": "2021-07-03",
#           "marketCode": "BUSINESS",
#           "end": "2021-07-03",
#           "roomTypeCharged": "{{RoomTypeCode}}",
#           "ratePlanCode": "{{RatePlanCode}}",
#           "roomType": "{{RoomTypeCode}}",
#           "pseudoRoom": false
#         },
#         "guestCounts": {
#           "children": 0,
#           "adults": 1
#         },
#         "departureDate": "{{currentdateplus1}}",
#         "arrivalDate": "{{currentdate}}"
#       }
#     }
#   },
#   "fetchInstructions": "Reservation"
# }

json = Chilkat::CkJsonObject.new()
json.UpdateInt("reservations.reservation.reservationGuests.profileInfo.profileIdList.id",123)
json.UpdateString("reservations.reservation.reservationGuests.profileInfo.profileIdList.type","Profile")
json.UpdateString("reservations.reservation.reservationPaymentMethods.paymentMethod","CA")
json.UpdateBool("reservations.reservation.markAsRecentlyAccessed",true)
json.UpdateString("reservations.reservation.hotelId","{{HotelId}}")
json.UpdateString("reservations.reservation.reservationStatus","Reserved")
json.UpdateString("reservations.reservation.reservationPackages.packageHeaderType.transactionDetails.calculationRule","F")
json.UpdateBool("reservations.reservation.reservationPackages.packageHeaderType.transactionDetails.allowance",false)
json.UpdateString("reservations.reservation.reservationPackages.packageHeaderType.transactionDetails.currency","USD")
json.UpdateString("reservations.reservation.reservationPackages.packageHeaderType.transactionDetails.postingType","D")
json.UpdateBool("reservations.reservation.reservationPackages.packageHeaderType.postingAttributes.addToRate",false)
json.UpdateBool("reservations.reservation.reservationPackages.packageHeaderType.postingAttributes.printSeparateLine",true)
json.UpdateBool("reservations.reservation.reservationPackages.packageHeaderType.postingAttributes.forecastNextDay",false)
json.UpdateString("reservations.reservation.reservationPackages.scheduleList.consumptionDate","{{currentdate}}")
json.UpdateInt("reservations.reservation.reservationPackages.scheduleList.unitPrice",2)
json.UpdateInt("reservations.reservation.reservationPackages.scheduleList.originalUnitPrice",2)
json.UpdateInt("reservations.reservation.reservationPackages.scheduleList.unitAllowance",0)
json.UpdateInt("reservations.reservation.reservationPackages.scheduleList.originalUnitAllowance",0)
json.UpdateString("reservations.reservation.reservationPackages.scheduleList.reservationDate","{{currentdate}}")
json.UpdateString("reservations.reservation.reservationPackages.endDate","{{currentdateplus1}}")
json.UpdateString("reservations.reservation.reservationPackages.packageCode","CHAMP")
json.UpdateString("reservations.reservation.reservationPackages.source","Reservation")
json.UpdateString("reservations.reservation.reservationPackages.startDate","{{currentdate}}")
json.UpdateBool("reservations.reservation.roomStay.guarantee.onHold",false)
json.UpdateString("reservations.reservation.roomStay.guarantee.guaranteeCode","6PM")
json.UpdateString("reservations.reservation.roomStay.roomRates.sourceCode","PHONE")
json.UpdateInt("reservations.reservation.roomStay.roomRates.numberOfUnits",1)
json.UpdateString("reservations.reservation.roomStay.roomRates.rates.rate.start","2021-07-03")
json.UpdateString("reservations.reservation.roomStay.roomRates.rates.rate.end","2021-07-03")
json.UpdateInt("reservations.reservation.roomStay.roomRates.rates.rate.base.amountBeforeTax",50)
json.UpdateString("reservations.reservation.roomStay.roomRates.rates.rate.base.currencyCode","USD")
json.UpdateString("reservations.reservation.roomStay.roomRates.start","2021-07-03")
json.UpdateString("reservations.reservation.roomStay.roomRates.marketCode","BUSINESS")
json.UpdateString("reservations.reservation.roomStay.roomRates.end","2021-07-03")
json.UpdateString("reservations.reservation.roomStay.roomRates.roomTypeCharged","{{RoomTypeCode}}")
json.UpdateString("reservations.reservation.roomStay.roomRates.ratePlanCode","{{RatePlanCode}}")
json.UpdateString("reservations.reservation.roomStay.roomRates.roomType","{{RoomTypeCode}}")
json.UpdateBool("reservations.reservation.roomStay.roomRates.pseudoRoom",false)
json.UpdateInt("reservations.reservation.roomStay.guestCounts.children",0)
json.UpdateInt("reservations.reservation.roomStay.guestCounts.adults",1)
json.UpdateString("reservations.reservation.roomStay.departureDate","{{currentdateplus1}}")
json.UpdateString("reservations.reservation.roomStay.arrivalDate","{{currentdate}}")
json.UpdateString("fetchInstructions","Reservation")

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

# resp is a CkHttpResponse
resp = http.PostJson3("https://domain.com/rsv/v1/hotels/{{HotelId}}/reservations/","application/json",json)
if (http.get_LastMethodSuccess() == false)
    print http.lastErrorText() + "\n";
    exit
end

print resp.get_StatusCode().to_s() + "\n";
print resp.bodyStr() + "\n";

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": {
			"reservationGuests": {
				"profileInfo": {
					"profileIdList": {
						"id": {{ProfileId}},
						"type": "Profile"
					}
				}
			},
			"reservationPaymentMethods": {
				"paymentMethod": "CA"
			},
			"markAsRecentlyAccessed": true,
			"hotelId": "{{HotelId}}",
			"reservationStatus": "Reserved",
			"reservationPackages": {
				"packageHeaderType": {
					"transactionDetails": {
						"calculationRule": "F",
						"allowance": false,
						"currency": "USD",
						"postingType": "D"
					},
					"postingAttributes": {
						"addToRate": false,
						"printSeparateLine": true,
						"forecastNextDay": false
					}
				},
				"scheduleList": {
					"consumptionDate": "{{currentdate}}",
					"unitPrice": 2,
					"originalUnitPrice": 2,
					"unitAllowance": 0,
					"originalUnitAllowance": 0,
					"reservationDate": "{{currentdate}}"
				},
				"endDate": "{{currentdateplus1}}",
				"packageCode": "CHAMP",
				"source": "Reservation",
				"startDate": "{{currentdate}}"
			},
			"roomStay": {
				"guarantee": {
					"onHold": false,
					"guaranteeCode": "6PM"
				},
				"roomRates": {
					"sourceCode": "PHONE",
					"numberOfUnits": 1,
					"rates": {
						"rate": {
							"start": "2021-07-03",
							"end": "2021-07-03",
							"base": {
								"amountBeforeTax": 50,
								"currencyCode": "USD"
							}
						}
					},
					"start": "2021-07-03",
					"marketCode": "BUSINESS",
					"end": "2021-07-03",
					"roomTypeCharged": "{{RoomTypeCode}}",
					"ratePlanCode": "{{RatePlanCode}}",
					"roomType": "{{RoomTypeCode}}",
					"pseudoRoom": false
				},
				"guestCounts": {
					"children": 0,
					"adults": 1
				},
				"departureDate": "{{currentdateplus1}}",
				"arrivalDate": "{{currentdate}}"
			}
		}
	},
	"fetchInstructions": "Reservation"
}'
https://domain.com/rsv/v1/hotels/{{HotelId}}/reservations/

Postman Collection Item JSON

{
  "name": "Create a new reservation with a package",
  "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",
        "type": "text",
        "value": "{{AppKey}}"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\r\n\t\"reservations\": {\r\n\t\t\"reservation\": {\r\n\t\t\t\"reservationGuests\": {\r\n\t\t\t\t\"profileInfo\": {\r\n\t\t\t\t\t\"profileIdList\": {\r\n\t\t\t\t\t\t\"id\": {{ProfileId}},\r\n\t\t\t\t\t\t\"type\": \"Profile\"\r\n\t\t\t\t\t}\r\n\t\t\t\t}\r\n\t\t\t},\r\n\t\t\t\"reservationPaymentMethods\": {\r\n\t\t\t\t\"paymentMethod\": \"CA\"\r\n\t\t\t},\r\n\t\t\t\"markAsRecentlyAccessed\": true,\r\n\t\t\t\"hotelId\": \"{{HotelId}}\",\r\n\t\t\t\"reservationStatus\": \"Reserved\",\r\n\t\t\t\"reservationPackages\": {\r\n\t\t\t\t\"packageHeaderType\": {\r\n\t\t\t\t\t\"transactionDetails\": {\r\n\t\t\t\t\t\t\"calculationRule\": \"F\",\r\n\t\t\t\t\t\t\"allowance\": false,\r\n\t\t\t\t\t\t\"currency\": \"USD\",\r\n\t\t\t\t\t\t\"postingType\": \"D\"\r\n\t\t\t\t\t},\r\n\t\t\t\t\t\"postingAttributes\": {\r\n\t\t\t\t\t\t\"addToRate\": false,\r\n\t\t\t\t\t\t\"printSeparateLine\": true,\r\n\t\t\t\t\t\t\"forecastNextDay\": false\r\n\t\t\t\t\t}\r\n\t\t\t\t},\r\n\t\t\t\t\"scheduleList\": {\r\n\t\t\t\t\t\"consumptionDate\": \"{{currentdate}}\",\r\n\t\t\t\t\t\"unitPrice\": 2,\r\n\t\t\t\t\t\"originalUnitPrice\": 2,\r\n\t\t\t\t\t\"unitAllowance\": 0,\r\n\t\t\t\t\t\"originalUnitAllowance\": 0,\r\n\t\t\t\t\t\"reservationDate\": \"{{currentdate}}\"\r\n\t\t\t\t},\r\n\t\t\t\t\"endDate\": \"{{currentdateplus1}}\",\r\n\t\t\t\t\"packageCode\": \"CHAMP\",\r\n\t\t\t\t\"source\": \"Reservation\",\r\n\t\t\t\t\"startDate\": \"{{currentdate}}\"\r\n\t\t\t},\r\n\t\t\t\"roomStay\": {\r\n\t\t\t\t\"guarantee\": {\r\n\t\t\t\t\t\"onHold\": false,\r\n\t\t\t\t\t\"guaranteeCode\": \"6PM\"\r\n\t\t\t\t},\r\n\t\t\t\t\"roomRates\": {\r\n\t\t\t\t\t\"sourceCode\": \"PHONE\",\r\n\t\t\t\t\t\"numberOfUnits\": 1,\r\n\t\t\t\t\t\"rates\": {\r\n\t\t\t\t\t\t\"rate\": {\r\n\t\t\t\t\t\t\t\"start\": \"2021-07-03\",\r\n\t\t\t\t\t\t\t\"end\": \"2021-07-03\",\r\n\t\t\t\t\t\t\t\"base\": {\r\n\t\t\t\t\t\t\t\t\"amountBeforeTax\": 50,\r\n\t\t\t\t\t\t\t\t\"currencyCode\": \"USD\"\r\n\t\t\t\t\t\t\t}\r\n\t\t\t\t\t\t}\r\n\t\t\t\t\t},\r\n\t\t\t\t\t\"start\": \"2021-07-03\",\r\n\t\t\t\t\t\"marketCode\": \"BUSINESS\",\r\n\t\t\t\t\t\"end\": \"2021-07-03\",\r\n\t\t\t\t\t\"roomTypeCharged\": \"{{RoomTypeCode}}\",\r\n\t\t\t\t\t\"ratePlanCode\": \"{{RatePlanCode}}\",\r\n\t\t\t\t\t\"roomType\": \"{{RoomTypeCode}}\",\r\n\t\t\t\t\t\"pseudoRoom\": false\r\n\t\t\t\t},\r\n\t\t\t\t\"guestCounts\": {\r\n\t\t\t\t\t\"children\": 0,\r\n\t\t\t\t\t\"adults\": 1\r\n\t\t\t\t},\r\n\t\t\t\t\"departureDate\": \"{{currentdateplus1}}\",\r\n\t\t\t\t\"arrivalDate\": \"{{currentdate}}\"\r\n\t\t\t}\r\n\t\t}\r\n\t},\r\n\t\"fetchInstructions\": \"Reservation\"\r\n}",
      "options": {
        "raw": {
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "{{HostName}}/rsv/v1/hotels/{{HotelId}}/reservations/",
      "host": [
        "{{HostName}}"
      ],
      "path": [
        "rsv",
        "v1",
        "hotels",
        "{{HotelId}}",
        "reservations",
        ""
      ]
    }
  },
  "response": [
  ]
}