Gränssnittsdefinition
Åtkomstpunkt
Verifiering: https://api-ver.lantmateriet.se/distribution/produkter/uppslag/adress/v3
Produktion: https://api.lantmateriet.se/distribution/produkter/uppslag/adress/v3
Schema
JSON: https://namespace.lantmateriet.se/distribution/produkter/uppslag/adress/v3/uppslag-adress-3.0.0.json
Format
Data kan endast hämtas i JSON-format.
Felmeddelande
Om ett fel uppstår skickas ett svar med en HTTP-felkod och ett Fault-meddelande.
Sammanfattning
Referens
Hämta referenser till belägenhetsadresser, med etikett och id.
| Operation | Beskrivning |
|---|---|
GET /fritext | Hitta registerenheter med en fritextsökning. |
Autocomplete
För användning av autocompletefunktioner. Hämtar stegvis adresser och slutligen en adressreferens, allteftersom söktexten fylls i.
| Operation | Beskrivning |
|---|---|
GET /autocomplete | Autocompletefunktion för att hitta adresser. |
Hälsokontroll
För att kolla om tjänsten är uppe och mår bra.
| Operation | Beskrivning |
|---|---|
GET /health | Hälsokontroll. |
Operationer
GET /fritext
Beskrivning
Hämta referenser till belägenhetsadresser genom en sökning på adressen.
Exempel
/fritext?adress=lantm%C3%A4terig%202%20g%27vle
/fritext?adress=kungsgatan&maxHits=15
Requestparametrar
| Namn | Beskrivning | Typ | Datatyp | Obligatorisk |
|---|---|---|---|---|
| adress | Söksträng. Måste innehålla 3-120 tecken. | query | string | ja |
| maxHits | Kan användas för att begränsa antal resultat. | query | integer | nej |
| splitAdress | Om satt till true så ersätts adressetiketten i svaret med ett objekt där adressen är utbruten i komponenter. | query | boolean | nej |
Svar
Ett fritextResponse i form av en JSON-array med adressreferenser.
GET /autocomplete
Beskrivning
För användning av autocompletefunktioner. Hämtar stegvis adresser och slutligen en adressreferens, allteftersom söktexten fylls i.
Den stegvisa sökningen funkar på följande vis:
| Beteckning | Resultat |
|---|---|
| (tom) | Alla kommuner |
| "g" | Alla kommuner som börjar på g |
| "gävle " (med mellanslag på slutet) | Alla adressområden i Gävle |
| "gävle la" | Alla adressområden i Gävle som börjar på la |
| "gävle lantmäterigatan " (med mellanslag på slutet) | Alla adressplatser på Lantmäterigatan i Gävle |
| "gävle lantmäterigatan 2" | Alla adressplatser på Lantmäterigatan i Gävle som börjar med 2 |
"gävle lantmäterigatan 2" och match=equals | Referens till adress vid Lantmäterigatan 2 i Gävle |
Exempel
/autocomplete
/autocomplete?adress=g%C3%A4vle%20lantm%C3%A4terigatan%20&match=startsWith&maxHits=20
/autocomplete?adress=g%C3%A4vle%20lantm%C3%A4terigatan%202b&match=equals
Requestparametrar
| Namn | Beskrivning | Typ | Datatyp | Obligatorisk |
|---|---|---|---|---|
| adress | Adress i ordningen <kommun>, <adressområde>, <adressplats> | query | string | nej |
| match | Default är
| query | string (x ∈ { "startsWith", "equals" }) | nej |
| maxHits | Kan användas för att begränsa svaret. Ange ett värde mindre eller lika med 0 för obegränsat antal. Default 100. | query | integer | nej |
| splitAdress | Om satt till true så ersätts adressetiketten i svaret med ett objekt där adressen är utbruten i komponenter. | query | boolean | nej |
Svar
Ett autocompleteResponse i form av en JSON-array med adresser eller adressreferenser, beroende på värdet på match-parametern.
GET /health
Beskrivning
För att kolla om tjänsten är uppe och mår bra.
Exempel
/health
Svar
Ett healthResponse i form av ett JSON-objekt med attributet "up" av typen boolean.
Datatyper
Svar
healthResponse
Anger status för tjänsten.
Properties
| Namn | Beskrivning | Typ | Multiplicitet |
|---|---|---|---|
| up | Anger status för tjänsten. | boolean | 1 |
Exempel
{"up": true}Felmeddelande
Fault
Properties
| Namn | Beskrivning | Typ | Multiplicitet |
|---|---|---|---|
| code | HTTP-felkod. | integer | 1 |
| reason | Textöversättning av felkod | string | 1 |
| errors | Mer detaljerad felbeskrivning | string | 0..* |
Exempel
{
"code": 400,
"reason": "Bad Request",
"errors": [
"adress must be present and contain 3-120 characters"
]
}