Teknisk beskrivning

Gränssnittsdefinition

Åtkomstpunkt

Verifiering: https://api-ver.lantmateriet.se/distribution/produkter/uppslag/adress/v2

Produktion: https://api.lantmateriet.se/distribution/produkter/uppslag/adress/v2

Schema

JSON: http://namespace.lantmateriet.se/distribution/produkter/uppslag/adress/v2/uppslag-adress-2.0.1.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 registerenheter, med etikett och id.

Operation	Beskrivning
`GET /fritext`	Hitta registerenheter med en fritextsökning.
`GET /fritext/{beteckning}`	Hitta registerenheter med en fritextsökning.

Beteckning

För användning av autocompletefunktioner. Hämtar stegvis adressbeteckningar och slutligen en registerenhetsreferens, allteftersom söktexten fylls i.

Operation	Beskrivning
`GET /beteckning`	Autocompletefunktion för att hitta adressbeteckningar.
`GET /beteckning/{beteckning}`	Autocompletefunktion för att hitta adressbeteckningar.

Operationer

GET /fritext

Beskrivning

Hämta referenser till registerenheter genom en sökning på adressbeteckningen.

Exempel

/fritext?beteckning=lantm%C3%A4terig%202%20g%27vle

/fritext?beteckning=kungsgatan&maxHits=15

Requestparametrar

Namn	Beskrivning	Typ	Datatyp	Obligatorisk
beteckning	Söksträng.	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 RegisterenhetsreferensResponse i form av en JSON-array med registerenhetsreferenser.

GET /fritext/{beteckning}

Beskrivning

Hämta referenser till registerenheter genom en sökning på adressbeteckningen.

Exempel

/fritext/lantmäterig 2 gävle

/fritext/kungsgatan?maxHits=15

Requestparametrar

Namn	Beskrivning	Typ	Datatyp	Obligatorisk
beteckning	Söksträng.	path	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 RegisterenhetsreferensResponse i form av en JSON-array med registerenhetsreferenser.

GET /beteckning

Beskrivning

För användning av autocompletefunktioner. Hämtar stegvis adressbeteckningar och slutligen en registerenhetsreferens, 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 registerenhet vid Lantmäterigatan 2 i Gävle

Exempel

/beteckning

/beteckning?beteckning=g%C3%A4vle%20lantm%C3%A4terigatan%20&match=STARTS_WITH&maxHits=20

/beteckning?beteckning=g%C3%A4vle%20lantm%C3%A4terigatan%202b&match=EQUALS

Requestparametrar

Namn	Beskrivning	Typ	Datatyp	Obligatorisk
beteckning	Adressbeteckning i ordningen <kommun>, <adressområde>, <adressplats>	query	string	nej
match	Default är `STARTS_WITH`. Möjliga värden: `STARTS_WITH` - stegvis sökning. `EQUALS` - returnera adressreferensen.	query	string (x ∈ { "startsWith", "equals", "STARTS_WITH", "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 BeteckningResponse i form av en JSON-array med beteckningar eller registerenhetsreferenser, beroende på värdet på match-parametern.

GET /beteckning/{beteckning}

Beskrivning

För användning av autocompletefunktioner. Hämtar stegvis adressbeteckningar och slutligen en registerenhetsreferens, 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 registerenhet vid Lantmäterigatan 2 i Gävle

Exempel

/beteckning/

/beteckning/gävle lantmäterigatan ?match=STARTS_WITH&maxHits=20

/beteckning/gävle lantmäterigatan 2b?match=EQUALS

Requestparametrar

Namn	Beskrivning	Typ	Datatyp	Obligatorisk
beteckning	Adressbeteckning i ordningen <kommun>, <adressområde>, <adressplats>	path	string	nej
match	Default är `STARTS_WITH`. Möjliga värden: `STARTS_WITH` - stegvis sökning. `EQUALS` - returnera adressreferensen.	query	string (x ∈ { "startsWith", "equals", "STARTS_WITH", "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 BeteckningResponse i form av en JSON-array med beteckningar eller registerenhetsreferenser, beroende på värdet på match-parametern.

Datatyper

Svar

RegisterenhetsreferensResponse

Behållare för sökningens resultat - ingen, en eller flera sökträffar av typen Registerenhetsreferens.

Properties

Namn	Beskrivning	Typ	Multiplicitet
Registerenhetsreferens		Registerenhetsreferens	0..*

Exempel

JSON

[
  {
    "objektidentitet": "a242061d-1ab9-4d74-991d-0e155685dd1e"
    "beteckning": "Gävle Gävle Lantmäterigatan 2D 80264 Gävle"
  },
  {
    "objektidentitet": "a1e51a4a-6846-4cde-9a92-3f8f788b47cd"
    "beteckning": "Gävle Gävle Lantmäterigatan 2A 80264 Gävle"
  }
]

BeteckningResponse

Properties

Namn Beskrivning Typ Multiplicitet

beteckning

Matchade delar av adressbeteckningar på formen "<kommun> <adressområde> <adressplats>".

beteckning och Registerenhetsreferens är ömsesidigt uteslutande.

string

0..*

Registerenhetsreferens

Referenser till registerenheter för matchade adresser.

beteckning och Registerenhetsreferens är ömsesidigt uteslutande.

Registerenhetsreferens

0..*

Exempel

JSON

[
  "Gävle Lasarettsvägen",
  "Gävle Lassas"
]

---

[
  {
    "objektidentitet": "85b7249e-d2c5-4d65-9ea5-4892ccf0e7bd"
    "adress": "Gävle Gävle Havsvägen 10 81491 Furuvik"
  },
  {
    "objektidentitet": "e4040900-8d78-43f0-965b-c8939327e095"
    "adress": "Gävle Hille Havsvägen 10 80596 Gävle"
  }
]

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

JSON

{
   "code": 400,
   "reason": "Bad Request",
   "errors": [
      "beteckning must be present and contain 1-120 characters"
   ]
}

Gränssnittsdefinition

Åtkomstpunkt

Schema

Format

Felmeddelande

Sammanfattning

Referens

Beteckning

Operationer

GET /fritext

Beskrivning

Exempel

Requestparametrar

Svar

GET /fritext/{beteckning}

Beskrivning

Exempel

Requestparametrar

Svar

GET /beteckning

Beskrivning

Exempel

Requestparametrar

Svar

GET /beteckning/{beteckning}

Beskrivning

Exempel

Requestparametrar

Svar

Datatyper

Svar

RegisterenhetsreferensResponse

Properties

Exempel

BeteckningResponse

Properties

Exempel

Felmeddelande

Fault

Properties

Exempel

Versionshistorik, Referens Uppslag Adress