GuidesAPI ReferenceChangelogGet API Access

Tags

Suggest Edits

Content is sometimes tagged for additional context in the sherpa° system. Below is the list of currently used tags and their descriptions.

Tag NameTag DescriptionTag Generation Details
internationalIs present when a restriction/procedure applies to an international traveller (one who is crossing an international border to enter the country/region).

Both international and domestic tags can be present, indicating that the restriction/procedure applies to all travellers.
domesticIs present when a restriction/procedure applies to an domestic traveller (one who is crossing a domestic border to enter the region e.g. across state/subdivision lines).
Both international and domestic tags can be present, indicating that the restriction/procedure applies to all travellers.
airTag is present when a restriction/procedure applies to travellers crossing borders by air.

Multiple travel mode tags can be present meaning that the restriction/procedure applies to all of the listed forms of travel
landSame as travelMode air
seaSame as travelMode air
transitThe transit tag appears on both restrictions and procedures but can appear from different sources internally.

The tag has the same meaning regardless: "This tag indicates that a restriction/procedure is applicable to travellers transiting through the country."		Procedures: when a procedure is marked as travelPurpose: TRANSIT , this tag will be generated.

Restrictions: Restrictions follow the same tag generation as procedures but includes an additional criteria: when restrictionSubType: TRANSIT is present.
businessThis tag indicates that a restriction/procedure is applicable to travellers entering/exiting a country for the given purpose of travel.All travelPurpose tags are generated based on the procedure logic above.

travelPurpose tags always exist on visa procedures.

The same is not true for other procedures. Unless explicitly defined, these tags do not appear on all procedures and in general can be interpreted as "this procedure applies for all travel purposes" when none appear.
medicalSame as travelPurpose business
tourismSame as travelPurpose business
fully_vaccinatedIndicates whether a restriction/procedure applies to ONLY fully vaccinated (COVID-19) travellersThis tag is generated when a restriction/procedure is applicable to ONLY fully vaccinated (COVID-19) travellers.

When neither fully_vaccinated or not_vaccinated tags are present, the restriction/procedure can be interpreted as "this applies to everybody regardless of vaccination status"

Learn more about vaccination tags.
not_vaccinatedIndicates whether a restriction/procedure applies to ONLY unvaccinated (COVID-19) travellersThis tag is generated when a restriction/procedure is applicable to ONLY unvaccinated (COVID-19) travellers.

When neither fully_vaccinated or not_vaccinated tags are present, the restriction/procedure can be interpreted as "this applies to everybody regardless of vaccination status"

Learn more about vaccination tags.

How does the Vaccination Tag work?

As vaccinations become more prevalent world wide, governments are starting to introduce differences in procedures and restrictions for vaccinated travellers. Common examples are relaxed quarantine and covid testing requirements for fully vaccinated traveller's.

If a Procedure or Restriction changes for vaccinated traveller's, it will now become two entries. The one for unvaccinated traveller's can include all information, including vaccination exemptions, but the one for vaccinated traveller's should include information for vaccinated traveller's only.

  1. Restrictions & Procedures now have a vaccinationStatus tag.
    The potential values for vaccinationStatus are:

    • FULLY_VACCINATED - This procedure/restriction applies to traveller's who are fully vaccinated only.
    • NOT_VACCINATED - This procedure/restriction applies to traveller's who are not vaccinated. We still include vaccination details in the description & exemptions for these entries.
    • If you see both of the above values in vaccinationStatus, or neither of them, the procedure/restriction applies to everyone regardless of vaccination status.

  2. Any country with changes for vaccinated traveller's must include a "proof of vaccination" procedure. Remember, traveller's will need to prove that they are vaccinated! Note that different countries define this differently, with some saying both doses is enough, and some saying that traveller's must be a certain number of days post vaccination (usually 10 or 14). This procedure should have a documentType of COVID_19_VACCINATION.

❗️

Resultset differences between /trips and other endpoints

Please note that for API /trips endpoint leaves it blank and provides data equivalent to FULLY_VACCINATED unless the vaccinated toggle is passed.

The expectation on our other endpoints excluding /trips endpoint would be: No filter is passed, so both tags are visible FULLY_VACCINATED and NOT_VACCINATED.

Updated 10 months ago