Booking HCN Query
The BookingHCNQuery operation allows customer to retrieve the Hotel Confirmation Number for their bookings, which is a booking confirmation number directly from the hotel. The HCN is not available immediately and will be available only for bookings with an arrival date within the next 7 days.
BookingHCNQuery accepts any of the optional parameters outlined below and returns an array of booking hotel confirmation numbers that are due to arrive within the next 7 days.
BookingHCNQuery Request Syntax
Request Headers
Content-Type: “text/xml; charset=utf-8”
Content-Length: [Length of the content]
Host: [Web service hostname]
Accept-Encoding “gzip”
Request Body Schema
| Name | Type | Description |
|---|---|---|
|
<Authority> |
Complex |
Authentication information, as described in the ‘Getting Started’ section |
|
<Org> |
String |
The organisation short code identifying the agent responsible for the request (Agency ID) |
|
<User> |
String |
The user’s logon, unique within the given organisation (User Name) |
|
<Password> |
String |
The given user’s password |
|
<Currency> |
String |
Choose the currency used to return selling prices; accepts an ISO-4217 / SWIFT three character currency code (e.g. USD, GBP, EUR). Your account has a configured billing currency. Only the configured currency can be specified here |
|
<Version> |
String |
The current interface version is 1.28 |
|
<QueryParams> |
Complex |
Contains any optional elements which form the query filter parameters |
|
<BookingId> (optional) |
Integer |
If included in the request with a Booking Id matching an existing booking, only the matching booking is returned regardless of other parameters |
Response Body Schema
| Name | Type | Description |
|---|---|---|
|
<Booking> (0 or more) |
Complex |
A booking structure, which matches the specified filter parameters. |
|
<Id> |
Integer |
If the booking Id is matched, then just the matching booking is returned regardless of other parameters |
|
<HotelBooking> (0 or more) |
Complex |
A booking structure which matches the specified filter parameters |
|
<ArrivalDate> |
Date |
The date of the first night of the stay |
|
<Nights> |
Integer |
The duration of the stay as a number of nights |
|
<Status> |
Enum |
Current status of the booking with <Id> specified |
|
<Room> (one or more) |
Complex |
Structure containing room requirement and occupant details |
|
<Guests> |
Array |
An array of either <Adult> or <Child> elements representing the guests who will stay in this room |
|
<Adult> (0 or more) |
Complex |
A structure representing one adult guest |
|
title,first,last (Attributes) (may be optional) |
String |
The name of this guest If the booking Id is matched then just the matching booking is returned regardless of other parameters |
|
<HCN> |
String |
The Hotel Confirmation number as provided by the property booked |
XML Response Sample
Samples
