Autocomplete

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 http://dawa.aws.dk/autocomplete

Parametre

NavnBeskrivelse
typeAngiver, 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
startfraAutocomplete 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"
qSøgetekst - den tekst brugeren har indtastet
caretposPosition af careten (cursoren) i den tekst brugeren har indtastet
postnrBegræns søgning til det angivne postnummer (Flerværdisøgning mulig).
kommunekodeBegræns søgning til adresser indenfor den angivne kommune (Flerværdisøgning mulig).
adgangsadresseidBegræns søgning til adresser med den angivne adgangsadresseid
multilinjeAngiver, om forslag formateres med linjeskift. Mulige værdier: true eller false. Default false.
supplerendebynavnAngiver, om adresser formateres med supplerende bynavn. Mulige værdier: true eller false. Default true.
stormodtagerpostnumreAngiver, 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.
fuzzyAktiver fuzzy søgning
idReturner 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.
callbackOutput leveres i JSONP format. Se Dataformater.
formatOutput leveres i andet format end JSON. Se Dataformater.
noformatParameteren angiver, at whitespaceformatering skal udelades
sideAngiver hvilken siden som skal leveres. Se Paginering.
per_sideAntal resultater per side. Se Paginering.

Eksempler

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

http://dawa.aws.dk/autocomplete?q=Magreteplasen 4, 8&caretpos=18&fuzzy=

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

http://dawa.aws.dk/autocomplete?q=Marg 4, 8000 Aarhus C&caretpos=4

Beskrivelse af autocomplete-svar

NavnTypeOptioneltBeskrivelse
typestringnejForslagets type: "vejnavn", "adgangsadresse" eller "adresse"
tekststringnejDen tekst, som input-feltet skal udfyldes med, hvis brugeren vælger forslaget
caretposintegernejDen position hvor careten (cursoren) skal placeres i inputfeltet, hvis brugeren vælger forslaget
forslagstekstintegernejDen tekst, der skal vises for dette forslag. Kan afvige fra den tekst der skal udfyldes i input-feltet.
dataobjectnejUdvalgte datafelter for vejnavnet, adgangsadressen eller adressen der returneres.