Hoppa till huvudsakligt innehåll

Teknisk beskrivning

Gränssnittsdefinition

Åtkomstpunkt

Verifiering: https://api-ver.lantmateriet.se/distribution/produkter/fastighetsamfallighet/v3.1

Produktion: https://api.lantmateriet.se/distribution/produkter/fastighetsamfallighet/v3.1

Schema

XML: http://namespace.lantmateriet.se/distribution/produkter/fastighetsamfallighet/v3.1/fastighet-samfallighet-3.1.0.xsd

JSON: http://namespace.lantmateriet.se/distribution/produkter/fastighetsamfallighet/v3.1/fastighet-samfallighet-3.1.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

Fastighet Samfällighet

Hämta hela - eller delmängder av - fastigheter och samfälligheter.

OperationBeskrivning
GET /{id}
Hämta en registerenhet med id.
POST /Hämta en eller flera registerenheter med id.

Referens

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

OperationBeskrivning
POST /referens/geometri
Hitta registerenheter med en geometri.
GET /referens/aktbeteckningHitta registerenheter med aktbeteckning.

Hälsokontroll

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

Operation

Beskrivning

GET /health Hälsokontroll.

Operationer

GET /{id}

Beskrivning

Hämta en fastighet eller samfällighet med objektidentitet. Delar av registerenheten kan hämtas genom includeData-parametern.

Exempel

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

/10000008-cafe-cafe-cafe-100000000002?includeData=basinformation,registerbeteckning

Requestparametrar

NamnBeskrivningTypDatatypObligatorisk
idRegisterenhetens objektidentitet.pathstringja
includeData

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

  • basinformation - hämtar Fastighetsattribut eller Samfallighetsattribut, PagaendeArende, Registerenhetsanmarkning, UrholkasAv samt Skattetal.
  • registerbeteckning - hämtar Registerbeteckning.
  • beteckningForeReformen - hämtar AldreTidigareRegisterbeteckning.
  • atgard - hämtar Fastighetsatgard.
  • omrade - hämtar Markomrade, 3D-utrymme och Fiskeomrade.
  • historik - hämtar Ursprung, AvskildMark och AvregistreradTill.
  • andel - hämtar DelI och Delagare.
  • total - hämtar allt.
querystring[] (x ∈ { "basinformation", "registerbeteckning", "beteckningForeReformen", "atgard", "omrade", "historik", "andel", "total" })nej
sridReferenssystem för geometrier. Default: 3006.queryintegernej
instantEndast för internt bruk. För vilken tid informationen ska hämtas. Som default hämtas den senaste versionen av informationen.queryintegernej

Svar

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


POST /

Beskrivning

Hämta en eller flera registerenheter med id. 250 id:n kan skickas in i samma fråga men att ange fler än en objektidentitet kräver utökad behörighet. Delar av registerenheten kan hämtas genom includeData-parametern.

Exempel

/?includeData=total

Body, Content-Type: application/xml
<IdRequest
    xmlns="http://namespace.lantmateriet.se/distribution/produkter/fastighetsamfallighet/v3.1">
  <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 registerenheten som ska hämtas. Flera delmängder kan anges som en kommaseparerad lista. Som default hämtas ingenting. Möjliga värden:

  • basinformation - hämtar Fastighetsattribut eller Samfallighetsattribut, PagaendeArende, Registerenhetsanmarkning, UrholkasAv samt Skattetal.
  • registerbeteckning - hämtar Registerbeteckning.
  • beteckningForeReformen - hämtar AldreTidigareRegisterbeteckning.
  • atgard - hämtar Fastighetsatgard.
  • omrade - hämtar Markomrade, 3D-utrymme och Fiskeomrade.
  • historik - hämtar Ursprung, AvskildMark och AvregistreradTill.
  • andel - hämtar DelI och Delagare
  • total - hämtar allt.
querystring[] (x ∈ { "basinformation", "registerbeteckning", "beteckningForeReformen", "atgard", "omrade", "historik", "andel", "total" })nej
sridReferenssystem för geometrier. Default: 3006.queryintegernej
instantEndast för internt bruk. För vilken tid informationen ska hämtas. Som default hämtas den senaste versionen av informationen.queryintegernej
Svar

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


POST /referens/geometri

Beskrivning

Hämta referenser till registerenheter inom en given geometri.

Exempel

/referens/geometri

Body, Content-Type: application/xml
<GeometriRequest
    xmlns="http://namespace.lantmateriet.se/distribution/produkter/fastighetsamfallighet/v3.1">
  <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.

Svar

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

GET /referens/aktbeteckning

Beskrivning

Hämta referenser till registerenheter med aktbeteckning. 

Exempel

/referens/aktbeteckning?aktbeteckning=28-74:562

Namn

Beskrivning

Typ

Datatyp

Obligatorisk

aktbeteckningAktbeteckningquerystringja

Svar

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

Referenserna refererar till registerenheter där den efterfrågade aktbeteckningen finns i något av följande attribut:

  • Registerenhet.avregistreringsaktbeteckning
  • Fastighetsatgard.aktbeteckning
  • Registerbetecknig.omregistreringsaktbeteckning
  • AldreTidigareRegisterbeteckning.omregistreringsaktbeteckning

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 registerenhet med angiven identifierare. Upp till 250 id:n kan anges i en fråga men att ange fler än en objektidentitet kräver utökad behörighet.

Properties

NamnBeskrivningTypMultiplicitet
idRegisterenhetens objektidentitet.string1..*

Exempel

XML
<IdRequest
    xmlns="http://namespace.lantmateriet.se/distribution/produkter/fastighetsamfallighet/v3.1">
  <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 registerenheter inom geometri. Vissa begränsningar finns:

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

500 000 m

Area för en Polygon eller sammanlagd area för en MultiSurface.30 000 000 m 2
Omkrets på en Polygon eller sammanlagd omkrets på en MultiSurface.1 000 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/fastighetsamfallighet/v3.1">
  <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
}


HealthResponse

Anger status för tjänsten.

Properties

NamnBeskrivningTypMultiplicitet
upAnger status för tjänsten.boolean1


Exempel

JSON
{"up": true}

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