Groups

The groups allows to customize the structure of the response by including additional, relevant information grouped into specific categories.

This functionality tailors the API responses to suit specific requirements, ensuring only the necessary data is received, which optimizes performance and reduces unnecessary data transfer.

How to Use

The groups[] parameter can be included in API requests to specify one or more groups of additional data to be included in the response.

Each group represents a category of data that provides more detailed information beyond the default response structure.

The structure of the response changes based on the specified groups.

Default Response (No Groups Specified)

When no groups are specified, the response includes basic information.

Get CDG Place without groups

GET /place/CDG

Example response

{
    "code": "CDG",
    "name": "Charles de Gaulle International Airport",
    "country": "FR",
    "icao": "LFPG",
    "state": "Ile-de-France",
    "latitude": 49.0127983093,
    "longitude": 2.5499999523,
    "timezone": "Europe/Paris",
    "type": "airport"
}

Response with "country" Group

When the country group is specified, the response includes additional country-specific details

Get CDG Place with groups

GET /place/CDG?groups[]=country

Example response

{
    "code": "CDG",
    "name": "Charles de Gaulle International Airport",
    "country": {
        "code": "FR",
        "name": "France",
        "code3": "FRA",
        "codeNumeric": "250",
        "region": "Europe"
    },
    "icao": "LFPG",
    "state": "Ile-de-France",
    "latitude": 49.0127983093,
    "longitude": 2.5499999523,
    "timezone": "Europe/Paris",
    "type": "airport"
}

Groups parameter

Groups parameter is optional. If no groups are specified, the API returns the default response structure. This means that the response will contain only the basic set of data without any additional grouped information.

Multiple groups can be included in the request by adding the groups[] parameter multiple times in the query string.

Each instance of groups[] should specify a different group name, allowing for the inclusion of various categories of additional data in a single API call.

GET /<resources>?groups[]=group1&groups[]=group2&groups[]=group3...

Additionally, there is a special group all which can be used to include all available groups in the response.

GET /<resources>?groups[]=all