/config

The /config API will return configuration and settings data for an airline that can be used to populate the user interface of the client app. The response size is relatively large (especially if connected via 3g) so it is recommended that the response data is cached locally. When making subsequent calls to /config after calling the API initially, you can specify the time of the lastUpdate from the server. If there have been no changes to the config, then the result will have success=true, but otherwise be empty.

GET /config

Verb URI Description
GET /config/{ver}/{airline} Get airline configuration parameters

Path Parameters

Verb URI Description
ver API Version number v1
airline 2 character IATA code MH

Query Parameters

Query Parameter Notes Example
lastUpdate The response to /config does not change frequently. To avoid transferring this data over the wire unnecessarily, you can pass as a query param the time when you previously called the API. It is recommended to use the lastUpdate value from the previous call to GET /config 2013-03-05T15:31:20.197Z

Response Data

This section provides a high level overview of the important, non-obvious elements of the response data.

  • lastUpdate : Date/time of when the configuration data on the server was last modified. Reuse this value on subsequent calls to GET /config, passing it in as a query param (?lastUpdate=....)
  • defaultAirport : The main home airport for the airline.
  • cabinClasses : An array of strings containing the valid cabin class for the airline. These are the only values that can be passed into the GET /shop API.
  • airports : An array of airport objects. This is the list of airports that the airline operates out of.
  • callCenters An array of call centre details.
    • titles - a hashmap of strings. The key is the 2 character language string, and the value is the title of the call centre to display to the user.
    • contactDetails - the call centre contact details.
  • airlineOffices : An array of airline offices. This list contains all the offices worldwide for this airline. The data includes address, phone and geo location data.
  • allowedFFPrograms : An array of frequent flyer programs that is valid for this airline. This will generally include the airline’s own frequent flyer program, and any airline alliance frequent flyer programs. It also includes a
  • mapValidRoutes : A hashmap of valid routes for this airline. The key is the departure airport code, and the value is an array of strings, each string is a valid arrival airport code.
  • payPalEnabled : Is PayPal a valid form of payment for this airline (true/false)
  • payPalSupportedCurrencies : Array of strings containing the currency code for which PayPal is supported
  • functionAvailable : Array of booleans that control which functionality is active for this airline. Some airlines support all APIs, some airlines only support a subset.
  • oneWorldTierMapping : Mapping of tier level to One World marketing name. The key is the tier level (e.g. BLUE, PLAT) , the value is the marketing name (e.g. Enrich Blue, Platinum). The tier level is returned as an SSR in the GET /reservations API.
  • termsAndConditions : A hashmap of strings containing the booking terms and conditions text. The key is the 2 character language string, and the value is the terms and conditions text. The text is a HTML formatted string to be displayed on a page on its own.
  • privacyPolicies : A hashmap of strings containing privacy policy text. The key is the 2 character language string, and the value is the privacy policy text. The text is a HTML formatted string to be displayed on a page on its own.
  • legalTexts : A hashmap of strings containing legal text. The key is the 2 character language string, and the value is the legal text. The text is a HTML formatted string to be displayed on a page on its own.