Autocomplete

Autocomplete API'et - En kombineret autocomplete funktionalitet.

DAWA tilbyder autocomplete til indtastning af vejnavne, adgangsadresser og adresser, som det kan læses i deres respektive API beskrivelser. For at implemente en optimal indtastning af adresser med autocomplete skal de tre autocomplete funktionaliteter kombineres. Når brugeren taster de første tegn autocompletes på vejnavne. Når vejnavnet er fundet autocompletes på adgangsadresser. Når adgangsadressen er fundet autocompletes på adresser. I applikationen, som skal anvende adresseindtastning med autocomplete, kan denne logik implementeres ved at kombinere de tre autocomplete typer.

En enklere og lettere måde at implementere indtastning af adresser med autocomplete er at anvende Autocomplete API’et beskrevet på denne side. Autocomplete API'et håndterer trinnene i adresse autocomplete: Først vejnavne, så adgangsadresser og endelig adresser. API'et kan anvendes i alle applikationstyper, web, mobil, desktop og server. Hvis det er en web applikation, hvori man ønsker at implementere adresse indtastning med autocomplete, kan det gøres endnu lettere - nemlig ved at anvende Autocomplete komponenten, som selvfølgelig er baseret på Autocomplete API'et.

Autocomplete

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

Parametre

Navn	Beskrivelse
`type`	Angiver, om brugeren er ved at indtaste et vejnavn, en adgangsadresse eller en adresse. Mulige værdier: "vejnavn", "adgangsadresse" eller "adresse". De returnerede værdier er ikke nødvendigvis af denne type. Hvis brugeren f.eks. er ved at indtaste en adresse, men ikke har indtastet nok til at vejnavnet er entydigt bestemt, så vil servicen returnere vejnavne som valgmuligheder for brugeren
`startfra`	Autocomplete søger igennem vejnavne, adgangsadresser og adresser. Som udgangspunkt returneres den første type, der giver mere end ét resultat. Med startfra parameteren angives, at søgningen skal starte senere i rækken. Hvis man f.eks. ikke ønsker, at der kan returneres vejnavne, angives startfra=adgangsadresse, og man vil få adgangsadresser tilbage, selvom mere end et vejnavn matcher søgningen. Parameteren er tiltænkt den situation, hvor brugeren vælger et vejnavn blandt de muligheder, som autocomplete-komponenten viser. I denne situation forventer brugeren, at der autocomplete-komponenten efterfølgende viser adgangsadresser. Ved at angive startfra=adgangsadresse sikres dette. Mulige værdier for parameteren: "vejnavn" (default), "adgangsadresse", "adresse"
`q`	Søgetekst - den tekst brugeren har indtastet
`caretpos`	Position af careten (cursoren) i den tekst brugeren har indtastet
`postnr`	Begræns søgning til det angivne postnummer (Flerværdisøgning mulig).
`kommunekode`	Begræns søgning til adresser indenfor den angivne kommune (Flerværdisøgning mulig).
`adgangsadresseid`	Begræns søgning til adresser med den angivne adgangsadresseid
`multilinje`	Angiver, om forslag formateres med linjeskift. Mulige værdier: true eller false. Default false.
`supplerendebynavn`	Angiver, om adresser formateres med supplerende bynavn. Mulige værdier: true eller false. Default true.
`stormodtagerpostnumre`	Angiver, om der returneres forslag med stormodtagerpostnumre. Mulige værdier: true eller false. Default false. Bemærk, at hvis stormodtagerpostnumre aktiveres, så kan samme adresse optræde to gange i listen af forslag.
`fuzzy`	Aktiver fuzzy søgning
`id`	Returner adresse eller adgangsadresse med den angivne ID. type-parameteren afgør, om der søges efter adgangsadresser eller adresser. Der returneres en tom array hvis (adgangs)adressen ikke findes.
`gældende`	Returner kun gældende adresser, ikke foreløbige.
`polygon`	Autocomplete indenfor polygon. Beregnet til mindre polygoner - store polygoner vil resultere i dårlig performance. 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]]].
`geometri`	Angiver hvilken geometri der anvendes ved geometriske søgninger (polygon- eller cirkelparametrene). Mulige værdier: "adgangspunkt" eller "vejpunkt".
`cirkel`	Autocomplete indenfor cirklen angivet af koordinatet (x,y) og radius r. Beregnet til mindre cirkler. Store cirkler vil resultere i dårlig performance. Som koordinatsystem kan anvendes (ETRS89/UTM32 eller) WGS84/geografisk. Radius angives i meter. cirkel={x},{y},{r}.
`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
`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

Autocomplete "Magreteplasen 4, 8" med fuzzy søgning slået til og careten placeret i slutningen af teksten

https://api.dataforsyningen.dk/autocomplete?q=Magreteplasen 4, 8&caretpos=18&fuzzy=

Autocomplete "Marg 4, 8000 Aarhus C" med careten placeret efter "Marg"

https://api.dataforsyningen.dk/autocomplete?q=Marg 4, 8000 Aarhus C&caretpos=4

Beskrivelse af autocomplete-svar

Navn	Type	Optionelt	Beskrivelse
type	string	nej	Forslagets type: "vejnavn", "adgangsadresse" eller "adresse"
tekst	string	nej	Den tekst, som input-feltet skal udfyldes med, hvis brugeren vælger forslaget
caretpos	integer	nej	Den position hvor careten (cursoren) skal placeres i inputfeltet, hvis brugeren vælger forslaget
forslagstekst	integer	nej	Den tekst, der skal vises for dette forslag. Kan afvige fra den tekst der skal udfyldes i input-feltet.
data	object	nej	Udvalgte datafelter for vejnavnet, adgangsadressen eller adressen der returneres.