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.1.xsd

JSON: http://namespace.lantmateriet.se/distribution/produkter/belagenhetsadress/v4.2/belagenhetsadress-4.2.1.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:

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.

Referens

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

Autocomplete

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

Hälsokontroll

För att kolla om tjänsten är uppe och mår bra.

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

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

<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>

["12345678-1234-1234-1234-123456789012", "10000008-cafe-cafe-cafe-100000000002"]

Requestparametrar

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

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

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

<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>

["12345678-1234-1234-1234-123456789012", "10000008-cafe-cafe-cafe-100000000002"]

Requestparametrar

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

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

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

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

<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>

{
  "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.

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:

Exempel

/autocomplete/adress

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

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

Requestparametrar

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

Svar

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

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 som anger tjänstens status. OBS! Denna fråga har ingen XML-variant.

Datatyper

Frågor

IdRequest

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

Properties

Exempel

<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>

["12345678-1234-1234-1234-123456789012", "10000008-cafe-cafe-cafe-100000000002"]

GeometriRequest

Hitta adress inom geometri. Vissa begränsningar finns:

Properties

Exempel

<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>

{
  "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
}

HealthResponse

Anger status för tjänsten.

Properties

Exempel

{
  "up": true
}

Felmeddelande

Fault

Properties

Exempel

<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>

{
   "code": 400,
   "reason": "Bad Request",
   "errors": [
      "Area is too large! Max is 1000000 - area is 1048076"
   ]
}