Supplerende bynavne

API'et udstiller Danmarks supplerende bynavne samt tilhørende funktionalitet.

Supplerende bynavnesøgning

Søg efter supplerende bynavne. Returnerer de supplerende bynavne, der opfylder kriteriet.

GET https://api.dataforsyningen.dk/supplerendebynavne2

Parametre

Navn	Beskrivelse
`q`	Tekstsøgning. Der søges i navnet. Alle ord i søgeteksten skal matche. Wildcard * er tilladt i slutningen af hvert ord. Der returneres højst 1000 resultater ved anvendelse af parameteren.
`autocomplete`	Udfør søgning som autocomplete-søgning.
`dagi_id`	Find det supplerende bynavn med det angivne DAGI ID (Flerværdisøgning mulig).
`navn`	Find det supplerende bynavn med det angivne navn. Case-sensitiv. (Flerværdisøgning mulig).
`kommunekode`	Find de supplerende bynavne i den angivne kommune.
`x`	Reverse geocoding. Find det supplerende bynavn for det angivne koordinat. Der benyttes det koordinatsystem, som er angivet i srid-parameteren (Default WGS84).
`y`	Reverse geocoding. Find det supplerende bynavn for det angivne koordinat.' + 'Der benyttes det koordinatsystem, som er angivet i srid-parameteren (Default WGS84).
`nærmeste`	Hvis denne parameter angives, sammen med x og y parametrene findes det supplerende bynavn der ligger nærmest det angivne punkt.
`callback`	Output leveres i JSONP format. Se Dataformater.
`format`	Output leveres i andet format end JSON. Se Dataformater.
`noformat`	Parameteren angiver, at whitespaceformatering skal udelades
`ndjson`	Output leveres i Newline Delimited JSON
`side`	Angiver hvilken siden som skal leveres. Se Paginering.
`per_side`	Antal resultater per side. Se Paginering.
`srid`	Angiver SRID for det koordinatsystem, som geospatiale parametre er angivet i. Default er 4326 (WGS84 / Geografiske koordinater). For ETRS89 / UTM zone 32 Nord anvender du 25832
`cirkel`	Find de supplerendebynavne, som overlapper den cirkel angivet af koordinatet (x,y) og radius r. Som koordinatsystem kan anvendes ETRS89/UTM32 eller WGS84/geografisk. Radius angives i meter. cirkel={x},{y},{r}.
`polygon`	Find de supplerendebynavne, som overlapper det angivne polygon. Polygonet specificeres som et array af koordinater på samme måde som koordinaterne specificeres i GeoJSON's polygon. Bemærk at polygoner skal være lukkede, dvs. at første og sidste koordinat skal være identisk. Som koordinatsystem kan anvendes (ETRS89/UTM32 eller) WGS84/geografisk. Dette angives vha. srid parameteren, se ovenover. Eksempel: polygon=[[[10.3,55.3],[10.4,55.3],[10.4,55.31],[10.4,55.31],[10.3,55.3]]].
`medtagnedlagte`	Medtag nedlagte supplerende bynavne. Bemærk, at nedlagte supplerende bynavne ikke har en geometri eller kommune tilknyttet.
`struktur`	Struktur parameteren angiver om der ønskes en flad eller en nestet svarstruktur. Default er nestet for JSON, og flad for GeoJSON.

Eksempler

Hent alle supplerende bynavne.

https://api.dataforsyningen.dk/supplerendebynavne2

Supplerende bynavnopslag

Modtag supplerende bynavn ud fra DAGI ID

GET https://api.dataforsyningen.dk/supplerendebynavne2/{dagi_id}

Parametre

Navn	Beskrivelse
`dagi_id`	Det supplerende bynavns unikke DAGI ID.
`medtagnedlagte`	Medtag nedlagte supplerende bynavne. Bemærk, at nedlagte supplerende bynavne ikke har en geometri eller kommune tilknyttet.
`callback`	Output leveres i JSONP format. Se Dataformater.
`format`	Output leveres i andet format end JSON. Se Dataformater.
`noformat`	Parameteren angiver, at whitespaceformatering skal udelades
`ndjson`	Output leveres i Newline Delimited JSON
`struktur`	Struktur parameteren angiver om der ønskes en flad eller en nestet svarstruktur. Default er nestet for JSON, og flad for GeoJSON.

Supplerende bynavn autocomplete

Autocomplete på supplerendebynavne. Der kan anvendes de samme parametre som ved søgning, men bemærk at q parameteren fortolkes anderledes. Læs mere under autocomplete.

GET https://api.dataforsyningen.dk/supplerendebynavne2/autocomplete

Parametre

Navn	Beskrivelse
`q`	Se beskrivelse under autocomplete
`autocomplete`	Udfør søgning som autocomplete-søgning.
`dagi_id`	Find det supplerende bynavn med det angivne DAGI ID (Flerværdisøgning mulig).
`navn`	Find det supplerende bynavn med det angivne navn. Case-sensitiv. (Flerværdisøgning mulig).
`kommunekode`	Find de supplerende bynavne i den angivne kommune.
`medtagnedlagte`	Medtag nedlagte supplerende bynavne. Bemærk, at nedlagte supplerende bynavne ikke har en geometri eller kommune tilknyttet.
`callback`	Output leveres i JSONP format. Se Dataformater.
`format`	Output leveres i andet format end JSON. Se Dataformater.
`noformat`	Parameteren angiver, at whitespaceformatering skal udelades
`ndjson`	Output leveres i Newline Delimited JSON
`side`	Angiver hvilken siden som skal leveres. Se Paginering.
`per_side`	Antal resultater per side. Se Paginering.

Beskrivelse af supplerende bynavne

Ovenstående Web API udstiller supplerende bynavne. Et supplerende bynavn – typisk landsbyens navn – eller andet lokalt stednavn der er fastsat af kommunen for at præcisere adressens beliggenhed indenfor postnummeret. Indgår som en del af den officielle adressebetegnelse. Indtil 34 tegn. Eksempel: ”Sønderholm”.

API'et udstiller for hver supplerende bynavn følgende informationer:

Navn		Type	Optionelt	Beskrivelse
href		string	nej	Det supplerende bynavns URL
dagi_id		string	nej	Unik ID
ændret		string	ja	Tidspunkt for seneste ændring registreret i DAWA. Opdateres ikke hvis ændringen kun vedrører geometrien (se felterne geo_ændret og geo_version).
geo_version		integer	ja	Versionsangivelse for geometrien. Inkrementeres hver gang geometrien ændrer sig i DAWA.
geo_ændret		string	ja	Tidspunkt for seneste ændring af geometrien registreret i DAWA.
bbox		array	ja	Geometriens bounding box, dvs. det mindste rectangel som indeholder geometrien. Består af et array af 4 tal. De første to tal er koordinaterne for bounding boxens sydvestlige hjørne, og to sidste tal er koordinaterne for bounding boxens nordøstlige hjørne. Anvend srid parameteren til at angive det ønskede koordinatsystem.
	item	number	nej
visueltcenter		array	ja	Geometriens visuelle center. Kan eksempelvis anvendes til placering af labels.
	item	number	nej
navn		string	nej	Det supplerende bynavns navn.
darstatus		integer	nej	Det supplerende bynavns status i DAR. 3=gældende, 4=nedlagt
kommune		object	ja	Den kommune, som det supplerende bynavn ligger i.
	href	string	nej	Kommunens unikke URL.
	kode	string	nej	Kommunekoden. 4 cifre.
	navn	string	ja	Kommunens navn.
postnumre		array	nej	De postnumre, der forefindes i det supplerende bynavn.
	href	string	nej	Postnummerets unikke URL
	nr	string	nej	Postnummer
	navn	string	ja	Det navn der er knyttet til postnummeret, typisk byens eller bydelens navn. Repræsenteret ved indtil 20 tegn. Eksempel: ”København NV”.