GuidesAPI ReferenceChangelogGet API Access
Back to All
improved

Requirements API v2.3.1

almost 4 years ago by Ivan Sharko

Relationships are optionally included

Endpoint /countries now uses the include query param to provide a comma separated list of relationship objects.

Valid options are restriction and procedure.

Examples:

/countries?include=procedure

/countries?include=restriction

or the combination of both

/countries?include=procedure,restriction

/countries?include=restriction,procedure

Restrictions and Procedures can be filtered via countries

Endpoint /countries now supports filtering the startDate and endDate for the relationship objects 'procedure' and 'restriction'.

Examples:

In order to get the full list of countries of which a restriction starts on June 1st, 2020, following query can be used.

/countries?filter[restriction.startDate]=2020-06-01

Multiple relationship filters can be used, e.g. to get a list of countries, including their procedures and restrictions ending before July 10th, 2020 in Europe. 

/countries?filter[restriction.endDate]=2020-07-10&filter[procedure.endDate]=2020-07-10&filter[continent]=europe&include=restriction,procedure

Additional information about Countries

Countries now include new attributes visaStatus

visaStatus
Indicates if the country is currently issuing electronic travel visas.

  • SUSPENDED
    Electronic visas are currently not being issued
  • RESTRICTED
    Electronic visas are being issued, but additional restrictions or conditions apply.
  • NO_RESTRICTION
    Electronic visas are being issued, no additional restrictions or conditions apply.
  • UNKNOWN
    No information about the status for electronic visas available.
  • 'EMBASSY'
    Embassy visas are being issued.

Additional information about Restrictions and Procedures

Restrictions and Procedures now include new attributes 'travelPurpose', directionality as well as startDate and endDate.

travelPurpose
If applicable, a restriction or procedure may contain information about the purpose of travel.

List can include

  • TOURISM
    Recreational activities such as vacation.

  • BUSINESS
    Conducting business such as attending meetings.

  • TRANSIT
    Stop overs in transit to a final destination.

  • MEDICAL
    Medical reasons such as medical staff or surgeries.

directionality
Indicates if the restriction or procedures is more or less restrictive.
Valid options are

  • LESS
    The restriction or procedure has become less restrictive.
  • 'MORE'
    The restriction or procedure has become more restrictive.
  • 'NO_CHANGE'
    The restriction or procedure did not indicate a higher or lesser restriction.

startDate and endDate
Allows to filter an inclusive start and endDate

Additional Procedure Types

Following Procedure category types have been added
HEALTH_MEASURES
SANITIZATION
RE_ENTRY_PERMIT

Following Procedure subCategory types have been added
DOMESTIC
IN_AIRPORT

Temporary removed optional Links

We removed the optional, navigational link attributes which are part of the JSON API Specification.
Sources and document links remained unaltered.

Travel History included in Restrictions and Procedures

Restrictions and Procedures may only apply if a passenger travelled to a country or region within a certain time window. This information is now available in the responses.

{
    "meta": {
        "copyright": "Sherpa",
        "version": "2.3.0"
    },
    "data": {
        "id": "CHN",
        "type": "country",
        "attributes": {
            "type": "COUNTRY",
            "countryName": "China",
            "isoAlpha2": "CN",
            "isoAlpha3": "CHN",
            "citizenship": "Chinese",
            "continent": "Asia",
            "visaStatus": "EMBASSY",
            "entryStatus": "PARTIALLY_CLOSED",
            "exitStatus": "NO_RESTRICTION",
            "lastUpdatedAt": "2020-06-30T15:36:00Z",
            "lastCheckedAt": "2020-06-30T00:00:00Z",
            "stillCurrentAt": "2020-06-30T00:00:00Z"
        },
        "relationships": {
            "restrictions": {
                "meta": {
                    "count": 2
                },
                "data": [
                    {
                        "id": "2abcadb2-d819-43dc-9352-d44318dcd4d6",
                        "type": "RESTRICTION"
                    },
                    {
                        "id": "9d73d36e-6d74-4f06-984b-ebe06fd8e4f0",
                        "type": "RESTRICTION"
                    }
                ]
            },
            "procedures": {
                "meta": {
                    "count": 4
                },
                "data": [
                    {
                        "id": "5f037b5c-0902-4cb1-83f2-c08528c3ef58",
                        "type": "PROCEDURE"
                    },
                    {
                        "id": "6d60be56-ba06-45ef-9aa3-5eab45b2e19c",
                        "type": "PROCEDURE"
                    },
                    {
                        "id": "812580b7-c8d8-4943-a7fa-946c91660014",
                        "type": "PROCEDURE"
                    },
                    {
                        "id": "ff303b3e-46e5-4946-91d6-87d540a86b31",
                        "type": "PROCEDURE"
                    }
                ]
            }
        }
    },
    "included": [
        {
            "id": "2abcadb2-d819-43dc-9352-d44318dcd4d6",
            "type": "RESTRICTION",
            "attributes": {
                "country": "CHN",
                "title": "Entry restrictions for international travellers",
                "description": "Most international travellers are not allowed to enter China. International travellers holding visas issued before March 28th, residence permits, and those who qualify for visa exemptions are not allowed to enter China. Entry with diplomatic, service, courtesy or C visas will not be affected.",
                "directionality": "NO_CHANGE",
                "more": [
                    "International travellers coming to China for necessary economic, trade, scientific or technological activities or out of emergency humanitarian needs may apply for visas at Chinese embassies or consulates. Travellers with visas issued after March 28th will not be affected."
                ],
                "tags": [],
                "source": {
                    "sourceType": "GOVERNMENT",
                    "title": "Chinese Ministry of Foreign Affairs",
                    "url": "https://www.fmprc.gov.cn/mfa_eng/topics_665678/kjgzbdfyyq/t1761867.shtml"
                },
                "lastCheckedAt": "2020-06-30T00:00:00Z",
                "lastUpdatedAt": "2020-06-30T15:36:00Z",
                "stillCurrentAt": "2020-06-30T00:00:00Z",
                "createdAt": "2020-05-14T17:01:00Z",
                "startDate": "2020-03-28T00:00:00Z",
                "endDate": null,
                "category": "NO_ENTRY",
                "subCategory": "ENTRY"
            },
            "relationships": {
                "country": {
                    "meta": {
                        "count": 1
                    },
                    "data": {
                        "id": "CHN",
                        "type": "COUNTRY"
                    }
                }
            }
        },
        {
            "id": "9d73d36e-6d74-4f06-984b-ebe06fd8e4f0",
            "type": "RESTRICTION",
            "attributes": {
                "country": "CHN",
                "title": "Business travel restarts to and from Singapore",
                "description": "Singapore and China have agreed to a \"fast lane\" arrangement which allows essential travel for business and official purposes between Singapore and selected Chinese provinces and municipalities. ",
                "directionality": "LESS",
                "travelPurpose": [
                    "BUSINESS"
                ],
                "more": [
                    "Travellers wanting to take advantage of the 'fast-lane' arrangement will have to apply and follow specific guidelines. They will need prior approval, any necessary visa, and a negative test for COVID-19. On arrival, travellers will need to be tested for COVID-19 and will be required to follow a strict itinerary for the first 14 days."
                ],
                "tags": [],
                "source": {
                    "sourceType": "GOVERNMENT",
                    "title": "Singaporean Ministry of Foreign Affairs",
                    "url": "https://www.mti.gov.sg/-/media/MTI/Newsroom/Press-Releases/2020/05/Joint-Press-Statementfinal-cl.pdf"
                },
                "lastCheckedAt": "2020-06-23T00:00:00Z",
                "lastUpdatedAt": "2020-06-25T17:12:00Z",
                "stillCurrentAt": "2020-06-23T00:00:00Z",
                "createdAt": "2020-06-08T17:50:00Z",
                "startDate": "2020-06-08T00:00:00Z",
                "endDate": null,
                "category": "RESTRICTED_ENTRY",
                "subCategory": "ENTRY"
            },
            "relationships": {
                "country": {
                    "meta": {
                        "count": 1
                    },
                    "data": {
                        "id": "CHN",
                        "type": "COUNTRY"
                    }
                }
            }
        }
    ]
}

curl --location --request GET 'https://requirements-api.joinsherpa.com/v2/countries/CHN?key=<<API_KEY>>&filter[travelHistory]=USA,VNM&include=restriction'