Regions

Display travel details for domestic and regional travel.

Beyond general travel bans and procedures on a country level, many states, districts and other administrative divisions have imposed additional restrictions and measurements within their geographic and administrative area.

Regional information

Countries can be further divided into their respective subdivision, these can be states, districts, provinces, emirates, etc.

The regions endpoint is providing information about a specific region and its relationship with a country. Both regionCode and countryCode are ISO 3166-2 conform.

In addition a regionName and countryName is provided to display the country and or region in a human friendly and localized way.

{
    "meta": {
        "copyright": "Sherpa",
        "version": "2.4.0"
    },
    "data": [
        {
            "id": "US-AL",
            "type": "region",
            "attributes": {
                "type": "REGION",
                "regionCode": "US-AL",
                "regionName": "Alabama",
                "countryCode": "USA",
                "countryName": "United States of America"
            },
            "relationships": {
                "country": {
                    "meta": {
                        "count": 1
                    },
                    "data": {
                        "id": "USA",
                        "type": "COUNTRY"
                    }
                },
                "restrictions": {
                    "meta": {
                        "count": 0
                    },
                    "data": []
                },
                "procedures": {
                    "meta": {
                        "count": 0
                    },
                    "data": []
                }
            }
        }
    ]
}

Relationship between Country, Restrictions and Procedures

Each country has a number of administrative sub divisions which are represented by the Region resource in our API. Just like countries, a Region can have a series of Restrictions and Procedures bound to that specific region.


Did this page help you?