Supplerende bynavne (Forældet)

DEPRECATED: Der er udgivet et nyt API for supplerende bynavne: supplerendebynavn2.

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

Supplerende bynavnesøgning

(DEPRECATED) Søg efter supplerende bynavne. Returnerer de supplerende bynavne som opfylder kriteriet.

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

Parametre

Navn	Beskrivelse
`q`	Søgetekst. Der søges i vejnavnet. Alle ord i søgeteksten skal matche det supplerende bynavn. 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.
`navn`	Navnet på det supplerende bynavn, f.eks. Holeby (Flerværdisøgning mulig).
`postnr`	Postnummer. 4 cifre. (Flerværdisøgning mulig).
`kommunekode`	Kommunekode. 4 cifre. Eksempel: 0101 for Københavns kommune. (Flerværdisøgning mulig).
`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.

Eksempler

Find de supplerende bynavne som ligger i postnummeret 3700 Rønne

https://api.dataforsyningen.dk/supplerendebynavne?postnr=3700

Find de supplerende bynavne, hvor et ord i det supplerende bynavn starter med aar

https://api.dataforsyningen.dk/supplerendebynavne?q=aar*

Supplerende bynavnopslag

(DEPRECATED) Modtag supplerende bynavn.

GET https://api.dataforsyningen.dk/supplerendebynavne/{navn}

Parametre

Navn	Beskrivelse
`navn`	Navnet på det supplerende bynavn, f.eks. Holeby

Eksempler

Hent det supplerende bynavn med navn Aarsballe

https://api.dataforsyningen.dk/supplerendebynavne/Aarsballe

Supplerende bynavn autocomplete

(DEPRECATED) 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/supplerendebynavne/autocomplete

Parametre

Navn	Beskrivelse
`q`	Se beskrivelse under autocomplete
`autocomplete`	Udfør søgning som autocomplete-søgning.
`navn`	Navnet på det supplerende bynavn, f.eks. Holeby (Flerværdisøgning mulig).
`postnr`	Postnummer. 4 cifre. (Flerværdisøgning mulig).
`kommunekode`	Kommunekode. 4 cifre. Eksempel: 0101 for Københavns kommune. (Flerværdisøgning mulig).
`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.

Eksempler

Find alle supplerende bynavne som indeholder sejr

https://api.dataforsyningen.dk/supplerendebynavne/autocomplete?q=sejr

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 unikke URL
navn		string	nej	Det supplerende bynavn. Indtil 34 tegn. Eksempel: ”Sønderholm”.
kommuner		array	nej	Kommuner, som det supplerende bynavn er beliggende i.
	href	string	nej	Kommunens unikke URL.
	kode	string	nej	Kommunekoden. 4 cifre.
	navn	string	ja	Kommunens navn.
postnumre		array	nej	Postnumre, som det supplerende bynavn er beliggende i.
	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”.