Skip to main content

Air Schedules Availability

5.3.1
Air
Inventory
SOAP API
Travel Agency
  • The request now contains a new element providing calendar search for the same market for 1 to 40 consecutive days.
  • The request now contains additional element providing the option to search for specific flights (pairs of carrier code and flight number).
  • The response now includes the base date of each response block.
  • The interpretation of format date has changed from only the same day (as per current UTC time at time of receiving the request) to allowing up to three last days to be interpreted as current year.

API Information

Response Format
XML
Service Action Code
AirSchedulesAndAvailabilityRQ
Current Version
5.3.1
Target Audience
TN
Environment
Production

What's New

  • The request now contains a new element providing calendar search for the same market for 1 to 40 consecutive days.
  • The request now contains additional element providing the option to search for specific flights (pairs of carrier code and flight number).
  • The response now includes the base date of each response block.
  • The interpretation of format date has changed from only the same day (as per current UTC time at time of receiving the request) to allowing up to three last days to be interpreted as current year.

Business Value

  • Customer can now perform calendar search for the same market for 1 to 40 consecutive days.
  • Customer can now perform calendar search for specific flights.

New Features

In the Request

Optional

Parameter: Calendar

Type:

Description: Enables calendar search functionality

Sample Value:

<Calendar origin="JFK" destination="LAX" startDate="2020-02-20" days="14"/>
Note: If this element is used, the same request cannot contain any //OriginDestination elements - this is reflected in the schema. Use of this element does not change the response layout.

In the Request

Optional

Parameter: SpecificFlight

Type:

Description: Restricts the results to contain segments with specific marketing carrier and flight number pairs

Sample Value:

<SpecificFlight>
  <Segment marketingCarrier="1S" flightNumber="1234"/>
  <Segment marketingCarrier="1S" flightNumber="2345"/>
</SpecificFlight>
Note:

In the Response

Required

Parameter: baseDate

Type: string

Description: Contains the base search date of that specific OriginAndDestination.

Sample Value:

baseDate="2020-02-20"
Note:

In the Request

Optional

Parameter:

Type:

Description:

Sample Value:

 
Note:

Resolved Issues

In the Request

Required

The service will now interpret the short date format falling on the last three days to be on current year, instead of defaulting them to next year.As an example if a request is sent on 2019-08-15, the service will interpret short date formats "08-13", "08-14", as 2019-08-13 and 2019-08-14. The previous functionality would interpret the short dates as first future date which would mean "08-13", "08-14" to be interpreted as year 2020. This change was made to alleviate issues with client time-zones.

In the Request

Optional

Relase note ID: 12854


  • The users can specify a new optional attribute in the request to control whether service should return only online solutions.
  • The users can specify a new optional attribute in the request to control whether the system should forward Reservation Data to external systems

API Information

Response Format
XML
Service Action Code
AirSchedulesAndAvailabilityRQ
Current Version
5.2.0
Target Audience
TN
Environment
Production

What's New

  • The users can specify a new optional attribute in the request to control whether service should return only online solutions.
  • The users can specify a new optional attribute in the request to control whether the system should forward Reservation Data to external systems

New Features

In the Request

Optional

Parameter: //OriginDestination/Options/Carriers[@onlineOnly]

Type: boolean

Description: Control whether the system should return online solutions.

Sample Value:

<Carriers onlineOnly="false"/>
Note: If true, the system will generate only online solutions (i.e. with the same marketing carrier) out of given carriers. If no carriers are given, the system will generate online solutions from carriers available on the given market. If false, the system will use default rules.

In the Request

Optional

Parameter: //OriginDestination/Options/Availability[@allowReservationData]

Type: boolean

Description: Controls whether the system is allowed to forward Reservation/Journey data to external systems when retrieving availability

Sample Value:

<Availability allowReservationData="false"/>
Note: Allow Reservation Data from *current session* of the *current PNR/EPR* to be included in availability requests. This option has effect when availability data is refreshed from carrier's inventory system (for example when //Availability[@quality=TRY_TO_REFRESH] ). The Reservation Data, depending on the EPR used to establish the session and what is already booked, may include items such as passenger names, Frequent Flyer numbers (personal and/or corporate), PNR record locators, or segments already booked.

Relase note ID: 12892


  • The service is now available for all TN customers.

API Information

Response Format
XML
Service Action Code
AirSchedulesAndAvailabilityRQ
Current Version
5.0.0
Target Audience
TN
Environment
Production

What's New

  • The service is now available for all TN customers.

New Features

In the Request

Optional

Parameter: //OriginDestination/Options/Availability[@quality]

Type: enumeration

Description: Lets the user control the quality of returned availability. Please refer to the documentation under each option for details. Also please note that some options have certain restrictions.

Sample Value:

<Availability quality="TRY_TO_REFRESH"/>
Note: Using this element allows to control the quality of the seat availability in the response. Up to two OriginDestinations per request can use enhanced availability quality, each for no more than 24 solutions. The limits do not change for the default availability quality.

In the Request

Optional

Parameter: //OriginDestination//TimeWindow[@reduceDuplicates]

Type: boolean

Description: If true, the service will attempt to remove solutions constructed from segments that are already present in the response, but on a different day. This option is left disabled by default for backwards compatibility.

Sample Value:

<TimeWindow before="2" before-unit="DAYS" after="2" after-unit="DAYS" reduceDuplicates="true"/>
Note: This option allows users to increase the diversity of solutions when searching for flights in a multi-day time span.

In the Request

Optional

Parameter: //OriginDestination/Options/Carriers/Carrier[@type]

Type: enumeration

Description: Carriers that must or must not appear in anywhere the response or carriers for which Carrier Specific Display data should be generated, depending on attributes in RequestedCarriers.

Sample Value:

<Carriers>
  <Carrier type="MARKETING">XX</Carrier>
  <Carrier type="OPERATING">YY</Carrier>
</Carriers>
Note: This element allows specifying if the given carrier should appear as marketing or operating carrier in generated solutions.

Functional Updates And Enhancements

In the Request

Optional

Parameter: cabins

Type: List of CabinCode

Description: List of cabin codes that are required to be available in at least 1 segment in each solution.

Sample Value:

<Availability>
  <cabins cabins="R F J C"/>
</Availability>
Note: The service accepts following Cabin notations: ATPCO (recommended), Legacy Host and Legacy Pricing

Relase note ID: 12952