Get Charter Availability
Returns available BookTran specials for the requested date range.
Request Profile Table
| Element | @Attribute |
Description/Contents |
| GetBookTranSpecials / GetBookTranSpecialsRequest |
Root element of message. |
| DateFrom |
Availability start date. |
| DateTo |
Availability end date. |
Scenario:
You want to know what BookTran Specials are available between 10/4/2020 and 1/5/2020.
Example message:
<GetBookTranSpecials>
<GetBookTranSpecialsRequest>
<DateFrom>2020-04-10</DateFrom>
<DateTo>2020-05-01</DateTo>
</GetBookTranSpecialsRequest>
</GetBookTranSpecials>
Response Profile Table
| Element | @Attribute |
Description/Contents |
| GetBookTranSpecialsResponse / GetBookTranSpecialsResult |
Root element of message. |
| BookTranSpecials |
Collection of BookTranSpecial objects. |
| BookTranSpecial |
Object representing a single BookTranSpecial. |
| @ID |
ID of the BookTranSpecial. |
| @Name |
Name of the BookTranSpecial. |
| @Description |
Long description of the BookTranSpecial. |
| @MinNights |
The minimum number of paid nights required to qualify for the BookTranSpecial. |
| @FreeNights |
The number of free nights available for the BookTranSpecial. |
| Periods |
Collection of Period objects. |
| Period |
Object representing a single Period that the BookTranSpecial is available. |
| @DateFrom |
Publicised Start date of the period. |
| @DateTo |
Publicised End date of the period. |
| @EffectiveDateFrom |
Effective start date of the the period (takes into account the AllowCrossBoundary flag on the BookTranSpecial which controls whether the entire BookTran must be within a Period or not). |
| @EffectiveDateTo |
Effective end date of the the period (takes into account the AllowCrossBoundary flag on the BookTranSpecial which controls whether the entire BookTran must be within a Period or not). |
Example message:
<GetBookTranSpecialsResponse xmlns="ResLink">
<GetBookTranSpecialsResult>
<BookTranSpecials>
<BookTranSpecial ID="1" Name="Go 5 Pay 4" Description="Book 4 nights and get a bonus 5th night free!" MinNights="4" FreeNights="1">
<Periods>
<Period DateFrom="2020-05-01T00:00:00" DateTo="2020-05-14T00:00:00" EffectiveDateFrom="2020-04-26T00:00:00" EffectiveDateTo="2020-05-14T00:00:00"/>
</Periods>
</BookTranSpecial>
<BookTranSpecial ID="2" Name="Go 7 Pay 5" Description="Pay for 5 nights and get another 2 nights FREE!" MinNights="5" FreeNights="2">
<Periods>
<Period DateFrom="2020-04-10T00:00:00" DateTo="2020-04-21T00:00:00" EffectiveDateFrom="2020-04-03T00:00:00" EffectiveDateTo="2020-04-21T00:00:00"/>
<Period DateFrom="2020-03-01T00:00:00" DateTo="2020-03-15T00:00:00" EffectiveDateFrom="2020-02-23T00:00:00" EffectiveDateTo="2020-03-15T00:00:00"/>
</Periods>
</BookTranSpecial>
</BookTranSpecials>
</GetBookTranSpecialsResult>
</GetBookTranSpecialsResponse>