Skip to main content

Structure of a location

A location is a physical meeting point: a building, a named place, an open space... Here is the complete list of fields defining a location.

FieldCodeEditableRequiredDescription
IdentifieruidUnique identifier of the location (not editable)
Location name (r)nameString (max. 100 characters). Example: Musée de la Folie Marco
External identifiersextIdsList of key/value pairs identifying the location in datasets external to OpenAgenda. See below for details.
Address (r)addressString (max. 255 characters)
AccessaccessMultilingual string (max. 1000 characters). Access instructions (e.g. { fr: "Métro 3, Pont de Levallois" })
DescriptiondescriptionMultilingual string (max. 5000 characters). Location presentation (see the example for Château de Villeneuve La Comtesse)
ImageimageURL or object illustrating the location
Image creditsimageCreditsCredits related to the illustration
SlugslugNon-editable text identifier
Location setsetUidIdentifier of the associated location set (not editable)
RegionadminLevel1Region (for locations in France)
DepartmentadminLevel2Department (for locations in France)
IntercommunalityadminLevel3Intercommunality
CityadminLevel4City or municipality
BoroughadminLevel5For large cities
NeighborhoodadminLevel6Neighborhood
Postal codepostalCodePostal code
INSEE codeinseeINSEE code of the municipality
Country (r)countryCodeISO 3166-1 alpha-2 country code (e.g. CH)
LatitudelatitudeDecimal geographic coordinate (e.g. 48.4102778)
LongitudelongitudeDecimal geographic coordinate (e.g. 7.4511111)
TimezonetimezoneExample: Europe/Paris
WebsitewebsiteMain URL
EmailemailMain contact email address
PhonephoneMain contact phone number
Other linkslinksList of hyperlinks (e.g. social networks, external website)
StatusstateLocation status: 0 (to be verified) or 1 (verified)
Creation datecreatedAtCreation date (not editable)
Last updated dateupdatedAtLast updated date (not editable)
External identifierextIdDeprecated: reference to the location in a dataset external to OpenAgenda

(g) automatically generated by geocoding if not provided

External identifiers

It is possible to associate identifiers other than the unique identifier (UID) with a location referenced on OpenAgenda. The UID is always defined and cannot be edited.

External identifiers are used to link locations to directories external to OpenAgenda. For example, the following data shows a location that carries a reference to the cultural venues database of the Ministry of Culture as well as another from a directory of the Nantes metropolitan area.

{
...
"extIds": [{
"key": "MCCBLCID",
"value": "62adc12a-3316-5d66-9e6f-ca989ada7a13?dc93fb2a-806a-45dc-90ed-b72324c12e69"
}, {
"key": "InfoNantes",
"value": "7894"
}],
...
}