Check Available
Checks that the requested class types are available for a specific trip. This takes into account ClassTypes which have configurations that allow them to be sold as combinations of other classtypes (such as a Twin Cabin that can be sold as 2x Singles).
Request Profile Table
| Element | @Attribute |
Description/Contents |
| CheckAvailable_RQ |
Root element of message. |
| RunID |
Element indicating the Run ID to check availability on. |
| BookingClassType |
Element indicating a booking class type. |
| @ClassTypeID |
Class type ID. |
| @PaxCount |
Number of passengers to allocate to this class type. |
| @Quantity |
Number of class types being used. Eg. for a room with two single beds, PaxCount would be 2, and Quantity would be 2. For a room with a single and a double (Total Capacity of 3) and three people staying in that room, PaxCount would be 3, and Quantity would be 1. |
Example message:
<?xml version="1.0" encoding="utf-8"?>
<CheckAvailable_RQ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<RunID xmlns="ResLink">12340</RunID>
<BookingClassTypes xmlns="ResLink">
<BookingClassType ClassTypeID="10" PaxCount="2" Quantity="1" />
<BookingClassType ClassTypeID="11" PaxCount="1" Quantity="1" />
</BookingClassTypes xmlns="ResLink">
</CheckAvailable_RQ>
Response Profile Table
| Element | @Attribute |
Description/Contents |
| CheckAvailable_RS |
Root element of message. |
| Valid |
Returns whether the requested Class Types are available for the specified trip |
| Status |
Element indicating the return status of the transaction. |
| @Code |
A numerical code for the status. |
| @Message |
The message of the status.
The messages (and corresponding codes) returned are:
| Code |
Message |
| 0 |
Check Available Success: Sufficient availability for requested Class Types. |
| 1 |
Check Available Failed: No Booking ClassTypes specified |
| 6 |
Check Available Failed: Run ID n does not exist. |
| 7 |
Check Available Failed: Insufficient availability for requested Class Types |
|
Example message:
<?xml version="1.0" encoding="utf-8"?>
<CheckAvailable_RS xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<Valid xmlns="ResLink">true</Valid>
<Status Code="0" Message="Sufficient availability for requested Class Types" xmlns="ResLink" />
<TimeStamp xmlns="ResLink"> 2009-12-03T16:08:35.0274665+10:00</TimeStamp>
<Errors xmlns="ResLink" />
<Warnings xmlns="ResLink" />
</CheckAvailable_RS>