GET /reference-data v2

GET / REFERENCE-DATA

The ReferenceData endpoint provides the reference data a consumer needs to support a customer to search for flight offers.

HOW TO USE?

The reference data is typically requested at the start of the use case.

HEADERS TO USE FOR REQUESTS

Parameter

Value

Authorization

Bearer {{token}}

Content-Type

application/json

Accept

application/hal+json;charset=utf8

Accept-Language

{{language}}-{{country}}

AFKL-TRAVEL-Host

KL or AF

AFKL-TRAVEL-Country

Country (overrides Accept-Language country)

GET https://api.klm.com/opendata/flightoffers/reference-data

QUERY PARAMETERS

Name

Type

Multiplicity

Description

-

RESPONSE PARAMETERS

Name

Type

Multiplicity

Description

cabinClasses

Array of Strings

1-n

Cabin classes that can be used to search for flight offers.

passengerTypes

Array of Strings

1-n

Types of passenger that can be used to search for flight offers.

continents

Array of Objects

1-n

List of available continents.

..code

String

1

Code identifying a continent.

..name

String

1

Name of the continent in the language as specified in ContentLanguage header.

..countries

Array of Objects

1-n

List available countries in continent.

….code

String

1

Code identifying a country.

….name

String

1

Name of the country in the language as specified in ContentLanguage header.

….settings

Object

1

Settings applicable to the booking process for the specific country.

……posCountry

String

1

Code for the country where the Point of Sale for specific country is located.

……maximumNumberOfSeats

Integer

1

Maximum number of seats that can be in a single booking from the requested country. Note that e.g. infants do not have their own seat.

…...minimumNumberOfAdults

Integer

1

Minimum number of adults that must be in a single booking from the specific country.

…...displayType

String

1

The default condition for displayed prices for the specific country. Can be overridden by request parameter (e.g. for LowestFareOffers).

…...countrySwitchMandatory

Boolean

1

Indicates whether or not it is mandatory to switch country when origin is not in allowedOrigins list for specific country.

……defaultAirport

String

1

IATA code for the default airport for the specific country.

……allowedOrigins

Array of Strings

0-n

List of origins that are allowed for the specific country. When countrySwitchMandatory setting is true, an origin not in the allowedOrigins list enforces that country must be switched.

….cities

Array of Objects

0-n

List of available cities in country.

Conditional: Country contains either a list of states or a list of cities.

……code

String

1

Code identifying a city.

……name

String

1

Name of the city in the language as specified in ContentLanguage header.

……isOrigin

Boolean

1

Indication whether the station can be used as origin of a flight.

……airports

Array of Objects

1-n

List of available airports in city.

……..code

String

1

Code identifying an airport.

……..name

String

1

Name of the airport in the language as specified in ContentLanguage header.

……..isOrigin

Boolean

1

Indication whether the station can be used as origin of a flight.

….states

Array of Objects

0-n

List of available states in country.

Conditional: Country contains either a list of states or a list of cities.

……code

String

1

Code identifying a state.

……name

String

1

Name of the state in the language as specified in ContentLanguage header.

……cities

Array of Objects

1-n

List of available cities in state.

……..code

String

1

Code identifying a city.

……..name

String

1

Name of the city in the language as specified in ContentLanguage header.

…..…isOrigin

Boolean

1

Indication whether the station can be used as origin of a flight.

…..…airports

Array of Objects

1-n

List of available airports in city

……....code

String

1

Code identifying an airport.

……....name

String

1

Name of the airport in the language as specified in ContentLanguage header.

……….isOrigin

Boolean

1

Indication whether the station can be used as origin of a flight.

ERROR CODES

HTTP status

Type

500

INTERNAL_SERVER_ERROR

SAMPLE RESPONSE

{
    "cabinClasses": [
        "ECONOMY",
        "BUSINESS"
    ],
    "passengerTypes": [
        "ADT",
        "CHD",
        "INF",
        "C14"
    ],
    "continents": [
        {
            "code": "EUR",
            "name": "Europa",
            "countries": [
                {
                    "code": "AT",
                    "name": "Oostenrijk",
                    "cities": [
                        {
                            "code": "VIE",
                            "name": "Wenen",
                            "airports": [
                                {
                                    "code": "VIE",
                                    "name": "Schwechat",
                                    "isOrigin": true
                                }
                            ],
                            "isOrigin": false
                        },
                        {
                            "code": "INN",
                            "name": "Innsbruck",
                            "airports": [
                                {
                                    "code": "INN",
                                    "name": "Innsbruck",
                                    "isOrigin": true
                                }
                            ],
                            "isOrigin": false
                        },
                        {
                            "code": "SZG",
                            "name": "Salzburg",
                            "airports": [
                                {
                                    "code": "SZG",
                                    "name": "Wolfgang a Mozart",
                                    "isOrigin": true
                                }
                            ],
                            "isOrigin": false
                        }
                    ]
                },
                {
                    "code": "BE",
                    "name": "België",
                    "cities": [
                        {
                            "code": "BRU",
                            "name": "Brussel",
                            "airports": [
                                {
                                    "code": "BRU",
                                    "name": "Brussels Airport",
                                    "isOrigin": true
                                },
                                {
                                    "code": "ZYR",
                                    "name": "Treinstation Brussel Midi",
                                    "isOrigin": true
                                }
                            ],
                            "isOrigin": true
                        },
                        {
                            "code": "ANR",
                            "name": "Antwerpen",
                            "airports": [
                                {
                                    "code": "ZWE",
                                    "name": "Antwerpen Centraal Station",
                                    "isOrigin": true
                                },
                                {
                                    "code": "ANR",
                                    "name": "Antwerp Int'l Airport",
                                    "isOrigin": true
                                }
                            ],
                            "isOrigin": true
                        },
                        {
                            "code": "LGG",
                            "name": "Luik",
                            "airports": [
                                {
                                    "code": "LGG",
                                    "name": "Liège Airport",
                                    "isOrigin": true
                                }
                            ],
                            "isOrigin": true
                        }
                    ]
                },
                {
                    "code": "NL",
                    "name": "Nederland",
                    "settings": {
                        "posCountry": "NL",
                        "maximumNumberOfSeats": 9,
                        "minimumNumberOfAdults": 1,
                        "displayType": "TAX",
                        "countrySwitchMandatory": false,
                        "defaultAirport": "AMS",
                        "allowedOrigins": [
                            "NL",
                            "AMS"
                        ]
                    },
                    "cities": [
                        {
                            "code": "AMS",
                            "name": "Amsterdam",
                            "airports": [
                                {
                                    "code": "AMS",
                                    "name": "Schiphol",
                                    "isOrigin": true
                                }
                            ],
                            "isOrigin": false
                        },
                        {
                            "code": "EIN",
                            "name": "Eindhoven",
                            "airports": [
                                {
                                    "code": "EIN",
                                    "name": "Eindhoven",
                                    "isOrigin": true
                                }
                            ],
                            "isOrigin": false
                        },
                        {
                            "code": "RTM",
                            "name": "Rotterdam",
                            "airports": [
                                {
                                    "code": "RTM",
                                    "name": "Rotterdam",
                                    "isOrigin": true
                                }
                            ],
                            "isOrigin": false
                        },
                        {
                            "code": "QNQ",
                            "name": "Nijmegen",
                            "airports": [
                                {
                                    "code": "QNQ",
                                    "name": "Nijmegen Railway Station",
                                    "isOrigin": true
                                }
                            ],
                            "isOrigin": true
                        },
                        {
                            "code": "ZYM",
                            "name": "Arnhem",
                            "airports": [
                                {
                                    "code": "QAR",
                                    "name": "Arnhem Bus Station",
                                    "isOrigin": true
                                }
                            ],
                            "isOrigin": true
                        }
                    ]
                }
            ]
        }
    ]
}

            

Docs Navigation