AdminPayload

Properties

Required

names

Property Type Description
names name Names of the admin area.

objectType

Property Type Description
objectType string Type of the Area. Administrative areas: These typically stem from an official sub-division of a country and oftentimes have a related governmental body. Named Place: an area that is locally defined. Postal Area: defined for postal addressing. Census Area: defined for demographic use cases

Optional

addressSignificance

Property Type Description
addressSignificance string

adminLevel

Property Type Description
adminLevel integer The AdminLevel of the Country is defined to be value 10. For every level down in the hierarchy, the level is increased. The "main" levels are defined as multiple of 10 (10, 20, 30, ...). This allows for multiple country specific "Sub Levels" in-between. All Levels above the country will be lower (9, 8, 7, etc...). The latter can be used for coding admin like "Europe", "Asia" or "United Kingdom". A full list of applicable Admin levels can be found in the Country Metadata.

annotationLabel

Property Type Description
annotationLabel AnnotationLabel

childPlaces

Property Type Description
childPlaces array Reference to the child places.
Items
Type Description
string Reference to Parent place.

country

Property Type Description
country string Reference to the country administrative level. This way the Country metadata only needs to be published ones.

countryMetadata

Property Type Description
countryMetadata CountryPayload

disputedArea

Property Type Description
disputedArea DisputedArea Only published in the case the Area is part of a dispute between multiple countries.

overlappingPlaces

Property Type Description
overlappingPlaces array Reference to the places that only have a partial geographical overlap. This Typically is the case with partial overlapping named areas
Items
Type Description
string Reference to overlapping Place.

parentplaces

Property Type Description
parentplaces string Reference to the parent places. For all levels below country, there must be at least one.
Items
Type Description
string Reference to Parent place.

spanning

Property Type Description
spanning boolean If an area is spanning, it means that the collection of all areas of the same level cover the parent.

statistics

Property Type Description
statistics object Statistical information related to the Admin Area. This is a free form Type/Value pair.

OneOf

Property Type Description
adminArea adminArea Statistical information related to the Admin Area. This is a free form Type/Value pair.
namedArea namedArea Statistical information related to the Admin Area. This is a free form Type/Value pair.
postalArea postalArea Statistical information related to the Admin Area. This is a free form Type/Value pair.
censusArea censusArea Statistical information related to the Admin Area. This is a free form Type/Value pair.

results matching ""

    No results matching ""