Hoppa till huvudsakligt innehåll

Teknisk beskrivning

Gränssnittsdefinition

Åtkomstpunkt

Verifiering: https://api-ver.lantmateriet.se/distribution/produkter/belagenhetsadress/v4.2

Produktion: https://api.lantmateriet.se/distribution/produkter/belagenhetsadress/v4.2

Schema

XML: http://namespace.lantmateriet.se/distribution/produkter/belagenhetsadress/v4.2/belagenhetsadress-4.2.0.xsd

JSON: http://namespace.lantmateriet.se/distribution/produkter/belagenhetsadress/v4.2/belagenhetsadress-4.2.0.json

Format

Data kan hämtas i XML- och JSON-format. Vilket format som önskas anges i HTTP-headern Accept med värdena application/xml eller application/json. I frågor som skickas in med POST ska motsvarande värden anges i headern Content-Type.

Referenssystem

I frågor som accepterar eller svarar med geometrier stöds följande referenssystem:

ReferenssystemSRID
SWEREF 99 TM3006
SWEREF 99 12 003007
SWEREF 99 13 303008
SWEREF 99 14 153012
SWEREF 99 15 003009
SWEREF 99 15 453013
SWEREF 99 16 303010
SWEREF 99 17 153014
SWEREF 99 18 003011
SWEREF 99 18 453015
SWEREF 99 20 153016
SWEREF 99 21 453017
SWEREF 99 23 153018

Felmeddelande

Om ett fel uppstår skickas ett svar med en HTTP-felkod och ett Fault-meddelande.

Sammanfattning

Adress

Hämta hela - eller delmängder av - adresser.

OperationBeskrivning
GET /{id} Hämta en adress med id.
POST / Hämta en eller flera adresser med id.
GET /registerenhet/{id} Hämta en eller flera adresser med registerenhetsid.
POST /registerenhet Hämta en eller flera adresser med registerenhetsid.
GET /punkt Hämta närmaste adress med koordinat.

Referens

Hämta referenser till adresser, med etikett och id.

OperationBeskrivning
GET /referens/fritext Hitta adresser med en fritextsökning.
POST /referens/geometri Hitta adresser med en geometri.

Autocomplete

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

OperationBeskrivning
GET /autocomplete/adress Autocompletefunktion för att hitta adresser.
GET /autocomplete/referensHämtar adressreferens från dess fulla autocompletetext.

Operationer

GET /{id}

Beskrivning

Hämta en adress med id. Delar av adressen kan hämtas genom includeData-parametern.

Exempel

/12345678-1234-1234-1234-123456789012?includeData=total&srid=3006

Requestparametrar

NamnBeskrivningTypDatatypObligatorisk
idAdressens objektidentitet.pathstring (uuid)ja
includeData

Vad i adressen som ska hämtas. Flera delmängder kan anges som en kommaseparerad lista. Som default hämtas ingenting. Möjliga värden:

  • basinformation - allt utom berörkretsen.
  • berorkrets - registerenheten.
  • total - allt.
querystring[] (x { "basinformation", "berorkrets", "total" })nej
sridReferenssystem för geometrier. Default: 3006.queryintegernej

Svar

Ett BelagenhetsadressResponse i form av en GeoJSON eller GML FeatureCollection med adresser, beroende på vilket format som efterfrågades.




POST /

Beskrivning

Hämta en eller flera adresser med id. 250 id:n kan skickas in i samma fråga. Delar av adressen kan hämtas genom includeData-parametern.

Exempel

/?includeData=total

Body, Content-Type: application/xml
<IdRequest
    xmlns="http://namespace.lantmateriet.se/distribution/produkter/belagenhetsadress/v4.2">
  <id>12345678-1234-1234-1234-123456789012</id>
  <id>10000008-cafe-cafe-cafe-100000000002</id>
</IdRequest>
Body, Content-Type: application/json
["12345678-1234-1234-1234-123456789012", "10000008-cafe-cafe-cafe-100000000002"]

Requestparametrar

Body: IdRequest - ett objekt innehållande en lista med objektidentiteter.

NamnBeskrivningTypDatatypObligatorisk
includeData

Vad i adressen som ska hämtas. Flera delmängder kan anges som en kommaseparerad lista. Som default hämtas ingenting. Möjliga värden:

  • basinformation - allt utom berörkretsen.
  • berorkrets - registerenheten.
  • total - allt.
querystring[] (x { "basinformation", "berorkrets", "total" })nej
sridReferenssystem för geometrier. Default: 3006.queryintegernej

Svar

Ett BelagenhetsadressResponse i form av en GeoJSON eller GML FeatureCollection med adresser, beroende på vilket format som efterfrågades.




GET /registerenhet/{id}

Beskrivning

Hämta en eller flera adresser med en registerenhets objektidentitet. Delar av adressen kan hämtas genom includeData-parametern.

Exempel

/registerenhet/12345678-1234-1234-1234-123456789012?includeData=total

Requestparametrar

NamnBeskrivningTypDatatypObligatorisk
idRegisterenhetens id i form av ett UUID.pathstring (uuid)ja
includeData

Vad i adressen som ska hämtas. Flera delmängder kan anges som en kommaseparerad lista. Som default hämtas ingenting. Möjliga värden:

  • basinformation - allt utom berörkretsen.
  • berorkrets - registerenheter.
  • total - allt.
querystring[] (x { "basinformation", "berorkrets", "total" })nej
sridReferenssystem för geometrier. Default: 3006.queryintegernej

Svar

Ett BelagenhetsadressResponse i form av en GeoJSON eller GML FeatureCollection med adresser, beroende på vilket format som efterfrågades.




POST /registerenhet

Beskrivning

Hämta en eller flera adresser med en eller flera registerenheters objektidentitet. 250 id:n kan skickas in i samma fråga. Delar av adressen kan hämtas genom includeData-parametern.

Exempel

/registerenhet?includeData=basinformation

Body, Content-Type: application/xml
<IdRequest
    xmlns="http://namespace.lantmateriet.se/distribution/produkter/belagenhetsadress/v4.2">
  <id>12345678-1234-1234-1234-123456789012</id>
  <id>10000008-cafe-cafe-cafe-100000000002</id>
</IdRequest>
Body, Content-Type: application/json
["12345678-1234-1234-1234-123456789012", "10000008-cafe-cafe-cafe-100000000002"]

Requestparametrar

Body: IdRequest - ett objekt innehållande en lista med objektidentiteter.

NamnBeskrivningTypDatatypObligatorisk
includeData

Vad i adressen som ska hämtas. Flera delmängder kan anges som en kommaseparerad lista. Som default hämtas ingenting. Möjliga värden:

  • basinformation - allt utom berörkretsen.
  • berorkrets - registerenheten.
  • total - allt.
querystring[] (x { "basinformation", "berorkrets", "total" })nej
sridReferenssystem för geometrier. Default: 3006.queryintegernej

Svar

Ett BelagenhetsadressResponse i form av en GeoJSON eller GML FeatureCollection med adresser, beroende på vilket format som efterfrågades.




GET /punkt

Beskrivning

Hämtar den adress som ligger närmast angiven punkt. Delar av adressen kan hämtas genom includeData-parametern.

Exempel

/punkt?punktSrid=3006&koordinater=6728782.15,616919.80&includeData=basinformation,berorkrets&srid=3006

Requestparametrar

NamnBeskrivningTypDatatypObligatorisk
punktSridVilket referenssystem punkten anges i. Default: 3006.queryintegernej
koordinaterPunktens koordinater, enligt ordningen northing, easting, separerade med ett kommatecken.querydecimalja
includeData

Vad i adressen som ska hämtas. Flera delmängder kan anges som en kommaseparerad lista. Som default hämtas ingenting. Möjliga värden:

  • basinformation - allt utom berörkretsen.
  • berorkrets - registerenheter.
  • total - allt.
querystring[] (x { "basinformation", "berorkrets", "total" })nej
sridReferenssystem för geometrier. Default: 3006.queryintegernej

Svar

Ett BelagenhetsadressResponse i form av en GeoJSON eller GML FeatureCollection med adresser, beroende på vilket format som efterfrågades.




GET /referens/fritext

Beskrivning

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

Exempel

/referens/fritext?adress=lantmäterig 2 gävle&maxHits=15

Requestparametrar
NamnBeskrivningTypDatatypObligatorisk
adressEn söksträng med 3 - 300 tecken.querystringja
kommunkodKommunkod, fyrsiffrig kod enligt Rikets indelningar.querystringnej
statusFiltrera på belägenhetsadresstatus.querystring[] (x { "Gällande", "Reserverad" })nej
maxHitsKan användas för att begränsa antal resultat. Max 500, default 100.queryintegernej
splitAdressOm värdet är true populeras AdressComponents i svaret. Default false.querybooleannej

Svar

Ett BelagenhetsadressreferensResponse i form av en JSON-array eller XML-lista med adressreferenser, beroende på vilket format som efterfrågades.




POST /referens/geometri

Beskrivning

Hämta referenser till adresser inom en given geometri.

Exempel

/referens/geometri

Body, Content-Type: application/xml
<GeometriRequest
    xmlns="http://namespace.lantmateriet.se/distribution/produkter/belagenhetsadress/v4.2">
  <Geometri>
    <gml:Polygon gml:id="ID_8" srsName="urn:ogc:def:crs:EPSG::3006"
        xmlns:gml="http://www.opengis.net/gml/3.2">
      <gml:exterior>
        <gml:LinearRing>
          <gml:posList>6728548 618174 6728423 618153 6728395 618270 6728525 618296 6728548 618174</gml:posList>
        </gml:LinearRing>
      </gml:exterior>
    </gml:Polygon>
  </Geometri>
  <buffer>50</buffer>
</GeometriRequest>
Body, Content-Type: application/json
{
  "geometri": {
    "type": "Polygon",
    "crs": {
      "type": "name",
      "properties": {
        "name": "urn:ogc:def:crs:EPSG::3006"
      }
    },
    "coordinates": [
      [ [618174, 6728548], [618153, 6728423], [618270, 6728395],
        [618296, 6728525], [618174, 6728548] ]
    ]
  },
  "buffer": 50
}

Requestparametrar

Body: GeometriRequest - ett objekt innehållande en geometri i GeoJSON- eller GML-format och eventuellt attributet buffer som kan användas för att utöka området runt geometrin.

NamnBeskrivningTypDatatypObligatorisk
statusFiltrera på belägenhetsadresstatus.querystring[] (x { "Gällande", "Reserverad" })nej
splitAdressOm värdet är true populeras AdressComponents i svaret. Default false.querybooleannej

Svar

Ett BelagenhetsadressreferensResponse i form av en JSON-array eller XML-lista med adressreferenser, beroende på vilket format som efterfrågades.




GET /autocomplete/adress

Beskrivning

För användning av autocompletefunktioner. Hämtar stegvis adresser allteftersom söktexten fylls i.

Den stegvisa sökningen funkar på följande vis:

BeteckningResultat
(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 2b" till GET /autocomplete/referensAdressreferens till Gävle Lantmäterigatan 2B

Exempel

/autocomplete/adress

/autocomplete/adress?adress=gävle lantmäterigatan &maxHits=20

/autocomplete/adress?adress=gävle lantmäterigatan 2b

Requestparametrar

NamnBeskrivningTypDatatypObligatorisk
adressAdressbeteckning i ordningen , , querystringnej
statusFiltrera på belägenhetsadresstatus.querystring[] (x { "Gällande", "Reserverad" })nej
maxHitsKan användas för att begränsa svaret. Ange ett värde mindre eller lika med 0 för obegränsat antal. Default 100.queryintegernej

Svar

Ett AutocompleteResponse i form av en JSON-array eller XML-lista med delar av adresser, beroende på vilket format som efterfrågades.




GET /autocomplete/referens

Beskrivning

För användning av autocompletefunktioner. Hämta referenser till adresser från dess fulla autocompletetext.

Exempel

/autocomplete/referens?adress=gävle lantmäterigatan 2b

Requestparametrar

NamnBeskrivningTypDatatypObligatorisk
adressEn söksträng med 3 - 300 tecken.querystringja
statusFiltrera på belägenhetsadresstatus.querystring[] (x { "Gällande", "Reserverad" })nej
maxHitsKan användas för att begränsa antal resultat. Max 500, default 100.queryintegernej
splitAdressOm värdet är true populeras AdressComponents i svaret. Default false.querybooleannej

Svar

Ett BelagenhetsadressreferensResponse i form av en JSON-array eller XML-lista med adressreferenser, beroende på vilket format som efterfrågades.

Datatyper

Frågor

IdRequest

Hämta adress med angiven identifierare. 250 idn kan anges i en fråga.

Properties
NamnBeskrivningTypMultiplicitet
idAdressens objektidentitet.string (uuid)1..*
Exempel
XML
<IdRequest
    xmlns="http://namespace.lantmateriet.se/distribution/produkter/belagenhetsadress/v4.2">
  <id>12345678-1234-1234-1234-123456789012</id>
  <id>10000008-cafe-cafe-cafe-100000000002</id>
</IdRequest>
JSON
["12345678-1234-1234-1234-123456789012", "10000008-cafe-cafe-cafe-100000000002"]




GeometriRequest

Hitta adress inom geometri. Vissa begränsningar finns:

BegränsningMaxvärde
Antal punkter i en MultiPoint.1 000 st
Antal brytpunkter i en LineString eller MultiCurve.1 000 st
Antal brytpunkter i en Polygon eller MultiSurface.1 000 st
Längd på en LineString eller sammanlagd längd på en MultiCurve.

100 000 m

Area för en Polygon eller sammanlagd area för en MultiSurface.1 000 000 m 2
Omkrets på en Polygon eller sammanlagd omkrets på en MultiSurface.200 000 m
Properties
NamnBeskrivningTypMultiplicitet
GeometriEn GML- eller GeoJSON-geometri. GML-geometrier ska följa Lantmäteriets GML 3.2.1-profil.geometri1
bufferOmråde runt den angivna geometrin som ska ingå i sökträffen.integer0..1
Exempel
XML
<GeometriRequest
    xmlns="http://namespace.lantmateriet.se/distribution/produkter/belagenhetsadress/v4.2">
  <Geometri>
    <gml:Polygon gml:id="ID_8" srsName="urn:ogc:def:crs:EPSG::3006"
        xmlns:gml="http://www.opengis.net/gml/3.2">
      <gml:exterior>
        <gml:LinearRing>
          <gml:posList>6728548 618174 6728423 618153 6728395 618270 6728525 618296 6728548 618174</gml:posList>
        </gml:LinearRing>
      </gml:exterior>
    </gml:Polygon>
  </Geometri>
  <buffer>50</buffer>
</GeometriRequest>
JSON
{
  "geometri": {
    "type": "Polygon",
    "crs": {
      "type": "name",
      "properties": {
        "name": "urn:ogc:def:crs:EPSG::3006"
      }
    },
    "coordinates": [
      [ [618174, 6728548], [618153, 6728423], [618270, 6728395],
        [618296, 6728525], [618174, 6728548] ]
    ]
  },
  "buffer": 50
}

Felmeddelande

Fault

Properties
NamnBeskrivningTypMultiplicitet
codeHTTP-felkod.integer1
reasonTextöversättning av felkodstring1
errorsMer detaljerad felbeskrivningstring0..*
Exempel
XML
<Fault
    xmlns="http://namespace.lantmateriet.se/distribution/produkter/fault/v1">
  <code>400</code>
  <reason>Bad Request</reason>
  <errors>Area is too large! Max is 1000000 - area is 1048076</errors>
</Fault>
JSON
{
   "code": 400,
   "reason": "Bad Request",
   "errors": [
      "Area is too large! Max is 1000000 - area is 1048076"
   ]
}