OriginDestinationInformation
| Child Name | Structural Type | Data Type | Description |
|---|---|---|---|
| RefNumber | attribute | int | Use 0 for the departing type, and 1 for the returning type. |
| DepartureDateTime | Child Element | complex | See Type. |
| ArrivalDateTime | Child Element | complex | See Type. |
| OriginLocation | Child Element | complex | See Type. |
| DestinationLocation | Child Element | complex | See Type. |
DepartureDateTime
| Child Name | Structural Type | Data Type | Description |
|---|---|---|---|
| value | date / datetime | The departure date of the flight. | |
| WindowBefore | attribute | int | Date Window specifying number of days BEFORE the specified date to also check. |
| WindowAfter | attribute | int | Date Window specifying number of days AFTER the specified date to also check. |
ArrivalDateTime
| Child Name | Structural Type | Data Type | Description |
|---|---|---|---|
| value | date / datetime | The arrival date of the flight. | |
| WindowBefore | attribute | int | Date Window specifying number of days BEFORE the specified date to also check. |
| WindowAfter | attribute | int | Date Window specifying number of days AFTER the specified date to also check. |
OriginLocation
| Child Name | Structural Type | Data Type | Description |
|---|---|---|---|
| LocationCode | attribute | string | The IATA/city code of the departure airport. |
| CodeContext | attribute | string | Use iata when the location code is an IATA code, city when using a city code see Locations. |
DestinationLocation
| Child Name | Structural Type | Data Type | Description |
|---|---|---|---|
| LocationCode | attribute | string | The IATA/city code of the departure airport. |
| CodeContext | attribute | string | Use iata when the location code is an IATA code, city when using a city code see Locations. |
TravelPreferences
| Child Name | Structural Type | Data Type | Description |
|---|---|---|---|
| FlightTypePref | Child Element | complex | See Type. |
| CabinPref | Child Element | complex | See Type. |
FlightTypePref
| Child Name | Structural Type | Data Type | Description |
|---|---|---|---|
| FlightType | attribute | string | Only Nonstop supported. |
| DirectAndNonStopOnlyInd | attribute | boolean | true / false. |
CabinPref
| Child Name | Structural Type | Data Type | Description |
|---|---|---|---|
| Cabin | attribute | string | First, Business , Premium or Economy. |
TravelerInfoSummary
| Child Name | Structural Type | Data Type | Description |
|---|---|---|---|
| AirTravelerAvail | Child Element | complex | See Type. |
AirTravelerAvail
| Child Name | Structural Type | Data Type | Description |
|---|---|---|---|
| PassengerTypeQuantity | Child Element | complex | See Type. Use four of these, one for each passenger type (Youth, Adult, Teen, Child, Infant) |
PassengerTypeQuantity
| Child Name | Structural Type | Data Type | Description |
|---|---|---|---|
| Code | attribute | int | 11 (Youth), 10 (Adult), 9 (Teen), 8 (Child), 7 (Infant). |
| Quantity | attribute | int | Number of travelers of this passenger type. |
PricedItineraries
| Child Name | Structural Type | Data Type | Description |
|---|---|---|---|
| PricedItinerary | Child Element | complex | See type. |
PricedItinerary
| Child Name | Structural Type | Data Type | Description |
|---|---|---|---|
| TicketingOffice | attribute | string | *For internal use, do not change this value. |
| AirItinerary | Child Element | complex | See type. |
AirItineraries
| Child Name | Structural Type | Data Type | Description |
|---|---|---|---|
| AirItinerary | Child Element | complex | See type. |
AirItinerary
| Child Name | Structural Type | Data Type | Description |
|---|---|---|---|
| DirectionInd | attribute | string | OneWay or Roundtrip |
| OriginDestinationOptions | Child Element | complex | See type. |
OriginDestinationOptions
| Child Name | Structural Type | Data Type | Description |
|---|---|---|---|
| OriginDestinationOption | Child Element | complex | See type. |
OriginDestinationOption
| Child Name | Structural Type | Data Type | Description |
|---|---|---|---|
| tsDuration | attribute | int | Duration of flight in milliseconds. |
| RefNumber | attribute | int | 1-based index. |
| FlightSegment | Child Element | complex | See type. |
FlightSegment
| Child Name | Structural Type | Data Type | Description |
|---|---|---|---|
| DepartureDateTime | attribute | dateTime | Time of departure. |
| ArrivalDateTime | attribute | dateTime | Time of arrival. |
| StopQuantity | attribute | int | Number of stops. |
| FlightNumber | attribute | int | Flight Number. |
| DepartureDay | attribute | string | 3-letter code for day of the week. |
| DepartureAirport | Child Element | complex | See Type. |
| ArrivalAirport | Child Element | complex | See Type. |
| OperatingAirline | Child Element | complex | See Type. |
| Equipment | Child Element | complex | See Type. |
| MarketingAirline | Child Element | complex | See Type. |
| FareBaggageAllowance | Child Element | complex | See Type. |
FareBaggageAllowance
| Child Name | Structural Type | Data Type | Description |
|---|---|---|---|
| UnitOfMeasureQuantity | attribute | string | This is the numeric value associated with the measurement. |
| UnitOfMeasure | attribute | string | This is the standard unit of measure name (e.g. kilograms). |
| UnitOfMeasureCode | attribute | string | The unit of measure in a code format (e.g. kg) |
| FlightSegmentRPH | attribute | string | The segment this baggage allowance is associated with. |
| Operation | attribute | string | Identifies an action to take place. (e.g. ADD, DELETE) |
| BaggageCode | attribute | string | The code for this specific baggage option. |
| BaggageCategory | attribute | string | Describes the category under which the baggage option falls. |
| BaggageDescription | attribute | string | Describes the baggage option. |
| BaggageIdentifier | attribute | string | Unique identifier for this baggage option. |
| PaxReference | attribute | string | The reference of the passenger to which this baggage is associated. |
| Amount | attribute | complex | Defines the charges for this baggage allowance |
| Included | attribute | boolean | true / false. Is the cost of the baggage option included in the fares. If false, then this can be offered as an option to the client |
| Extra | attribute | boolean | true / false. This is a extra baggage option. Not currently supported |
| Multi | attribute | boolean | true / false. This is a multi baggage option. Not currently supported |
| PerDirection | attribute | boolean | true / false. This baggage option applies to both outbound and inbound |
| PerPassenger | attribute | boolean | true / false. This baggage option applies to all passengers |
| PreSelected | attribute | boolean | true / false. This defines the default selected baggage option if it is set. This option will be used if no other option is selected. |
DepartureAirport
| Child Name | Structural Type | Data Type | Description |
|---|---|---|---|
| LocationCode | attribute | string | The IATA code of the arrival airport. |
| CodeContext | attribute | string | Use iata as the value. |
ArrivalAirport
| Child Name | Structural Type | Data Type | Description |
|---|---|---|---|
| LocationCode | attribute | string | The IATA code of the arrival airport. |
| CodeContext | attribute | string | Use iata as the value. |
OperatingAirline
| Child Name | Structural Type | Data Type | Description |
|---|---|---|---|
| CompanyShortName | attribute | string | Name of the airline offering the flight. |
| TravelSector | attribute | int | *For internal use, do not change this value. |
| Code | attribute | string | Airline IATA code. |
| CodeContext | attribute | string | Use iata as the value. |
MarketingAirline
| Child Name | Structural Type | Data Type | Description |
|---|---|---|---|
| CompanyShortName | attribute | string | Name of the airline offering the flight. |
| TravelSector | attribute | int | *For internal use, do not change this value. |
| Code | attribute | string | Airline IATA code. |
| CodeContext | attribute | string | Use iata as the value. |
BookingClassAvails
| Child Name | Structural Type | Data Type | Description |
|---|---|---|---|
| CabinType | attribute | string | First, Business or Economy . |
| BookingClassAvail | Child Element | complex | See Type. |
BookingClassAvail
| Child Name | Structural Type | Data Type | Description |
|---|---|---|---|
| ResBookDesigCode | attribute | string | *For internal use, do not change this value. |
| ResBookDesigQuantity | attribute | string | *For internal use, do not change this value. |
TravelerInfo
| Child Name | Structural Type | Data Type | Description |
|---|---|---|---|
| AirTraveler | Child Element | complex | See Type. |
AirTraveler
| Child Name | Structural Type | Data Type | Description |
|---|---|---|---|
| PassengerTypeCode | attribute | int | 11 (Youth), 10 (Adult), 9 (Teen), 8 (Child), 7 (Infant) |
| BirthDate | attribute | date | Traveler date of birth. (yyyy-mm-dd) |
| PersonName | Child Element | complex | See Type. |
| Telephone | Child Element | complex | See Type. |
| Child Element | complex | See Type. | |
| Address | Child Element | complex | See Type. |
| Document | Child Element | complex | See Type. |
| TSRequiredParameterValue | Child Element | complex | See Type. |
PersonName
| Child Name | Structural Type | Data Type | Description |
|---|---|---|---|
| GivenName | Child Element | complex | See Type. |
| Surname | Child Element | complex | See Type. |
| NameTitle | Child Element | complex | See Type. |
Telephone
| Child Name | Structural Type | Data Type | Description |
|---|---|---|---|
| PhoneTechType | attribute | int | 1 (landline) or 5 (mobile) |
| CountryAccessCode | attribute | string | International dialling code. |
| AreaCityCode | attribute | string | International dialling code. |
| PhoneNumber | attribute | string | International dialling code. |
| Child Name | Structural Type | Data Type | Description |
|---|---|---|---|
| EmailType | attribute | string | Email address. |
| Operation | attribute | string | Add |
Address
| Child Name | Structural Type | Data Type | Description |
|---|---|---|---|
| StreetNmbr | Child Element | string | Address house nr, street name, and suburb. |
| CityName | Child Element | string | The city the house is located in. |
| PostalCode | Child Element | string | postal code |
| CountryName | Child Element | complex | See Type. |
CountryName
| Child Name | Structural Type | Data Type | Description |
|---|---|---|---|
| Code | attribute | string | 2-letter country code ( ISO 3166-1 ) |
Document
| Child Name | Structural Type | Data Type | Description |
|---|---|---|---|
| DocType | attribute | string | Type of document (Passport, SFPD, etc). |
| BirthDate | attribute | date | Date of birth. (yyyy-mm-dd). |
TSRequiredParameterValue
| Child Name | Structural Type | Data Type | Description |
|---|---|---|---|
| Id | Child Element | string | Id denoting AirTraveler ProfileRef Id. |
| Type | Child Element | string | "date", "past date", "future date" , "string", "integer" or "boolean". |
| Name | Child Element | string | Name of parameter. |
| StringValue | Child Element | string | Must be set if the "Type" is either "string", "integer" or "boolean". |
| DateValue | Child Element | date | Must be set if the "Type" is either "date", "past date" or "future date". Format is (yyyy-mm-dd). |
TSRequiredParameter
| Child Name | Structural Type | Data Type | Description |
|---|---|---|---|
| Optional | attribute | boolean | true / false. If false, it must be returned as part of the book operation. |
| PerAdult | attribute | boolean | true / false. If true a TSRequiredParameterValue must be added to the Adult AirTraveler(s). |
| PerChild | attribute | boolean | true / false. If true a TSRequiredParameterValue must be added to the Child AirTraveler(s). |
| PerInfant | attribute | boolean | true / false. If true a TSRequiredParameterValue must be added to the Infant AirTraveler(s). |
| Name | Child Element | string | Parameter Name (to be copied to the relevant TSRequiredParameterValue). |
| Type | Child Element | string | Parameter Type (to be copied to the relevant TSRequiredParameterValue). |
Fulfillment
| Child Name | Structural Type | Data Type | Description |
|---|---|---|---|
| Code | attribute | string | 2-letter country code ( ISO 3166-1 ) |