Hoppa till huvudsakligt innehåll

Teknisk beskrivning

Gränssnittsdefinition

Åtkomstpunkt

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

Produktion: https://api.lantmateriet.se/distribution/produkter/markreglerandebestammelse/v2

Schema

XML: http://namespace.lantmateriet.se/distribution/produkter/markreglerandebestammelse/v2/markreglerande-bestammelse-2.0.1.xsd

JSON: http://namespace.lantmateriet.se/distribution/produkter/markreglerandebestammelse/v2/markreglerande-bestammelse-2.0.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:

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

Markreglerande bestämmelse

Hämta hela - eller delmängder av - markreglerande bestämmelser.

OperationBeskrivning
GET /{id} Hämta en markreglerande bestämmelse med id.
POST /
Hämta en eller flera markreglerande bestämmelser med id.

Referens

Hämta referenser till markreglerande bestämmelser, med id och etikett.

OperationBeskrivning
GET /referens
Hitta markreglerande bestämmelser med en alternativ identitet.
GET /referens/beror/{id} Hitta markreglerande bestämmelser som berör en fastighet eller samfällighet.
POST /referens/geometri
Hitta markreglerande bestämmelser med en geometri.

Beteckning

För användning av autocompletefunktioner. Hämtar stegvis bestämmelsebeteckningar och slutligen objektidentiteter, allteftersom söktexten fylls i.

Operation

Beskrivning

GET /beteckning/beteckning Autocompletefunktion för att hitta bestämmelsebeteckningar.
GET /beteckning/objektidentitet Hämtar objektidentiteter för bestämmelser.

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 markreglerande bestämmelse med objektidentitet. Delar av bestämmelsen kan hämtas genom includeData-parametern.

Exempel

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

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

Requestparametrar

NamnBeskrivningTypDatatypObligatorisk
idBestämmelsens objektidentitet.pathstring (uuid)ja
includeData

Vad i bestämmelsen 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 Plan-, Naturvardsbestammelse- , OvrigBestammelse- , Mineralrattighets- , UtredningMM- , eller Fornlamningsattribut, KopplarTill , Hanvisningstext, Beslut , Beroranmarkning samt Fornlamningslage.
  • berorkrets - hämtar Beror.
  • geometri - hämtar Yta.
  • total - hämtar allt.
querystring[] (x { "basinformation", "berorkrets", "geometri", "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 MarkreglerandeBestammelseResponse i form av en GeoJSON eller GML FeatureCollection med markreglerande bestämmelser, beroende på vilket format som efterfrågades.




POST /

Beskrivning

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

Exempel

/?includeData=total

Body, Content-Type: application/xml
<IdRequest
    xmlns="http://namespace.lantmateriet.se/distribution/produkter/markreglerandebestammelse/v2">
  <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 bestämmelsen 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 Plan-, Naturvardsbestammelse-, OvrigBestammelse-, Mineralrattighets-, UtredningMM-, eller Fornlamningsattribut, KopplarTill, Hanvisningstext, Beslut, Beroranmarkning samt Fornlamningslage.
  • berorkrets - hämtar Beror.
  • geometri - hämtar Yta.
  • total - hämtar allt.
querystring[] (x { "basinformation", "berorkrets", "geometri", "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 MarkreglerandeBestammelseResponse i form av en GeoJSON eller GML FeatureCollection med markreglerande bestämmelser, beroende på vilket format som efterfrågades.




GET /referens

Beskrivning

Hitta markreglerande bestämmelser med en alternativ identitet, t.ex. en aktbeteckning.

Exempel

/referens?id=2910-ABC

/referens?id=29&match=startsWith&status=g%C3%A4llande

Requestparametrar

NamnBeskrivningTypDatatypObligatorisk
idBestämmelsens alternativa identitet.querystringja
matchSätter hur det alternativa idt ska matchas. Default: equals .


querystring (x { "equals", "startsWith" })nej
idtypAnger om idt är av en viss sort. Som default söks alla sorter igenom.querystring (x { "bestämmelsebeteckning", "bestämmelsenamn", "alternativ beteckning", "extern registeridentitet", "lämningsnummer" })nej
kommunAnger bestämmelsens kommuntillhörighet.querystringnej
statusAnger bestämmelsens status.querystring (x { "gällande", "förslag", "avregistrerad" })nej
typAnger bestämmelsens typ.query

string (x { "avstyckningsplan", "byggnadsplan", "detaljplan", "fastighetsplan", "fråga väckt om förordnande", "förbud mot schaktning, trädfällning mm", "generalplan", "nybyggnadsförbud", "områdesbestämmelser", "regionplan", "stadsplan", "tomtindelning", "ändring av detaljplan", "ändring av områdesbestämmelser", "ändring av översiktsplan", "översiktsplan", "djur- och växtskyddsområde", "interimistiskt förbud", "kulturreservat", "landskapsbildsskydd", "nationalpark", "natura 2000-område", "naturminne", "naturreservat", "naturvårdsområde", "skogligt biotopskyddsområde", "vattenskyddsområde", "övrigt biotopskyddsområde", "anmälningsplikt byggnadsminne", "avgränsning av område för fornlämning", "bearbetningskoncession torv", "byggnadsminne", "fråga väckt om byggnadsminne", "gränsbestämda kyrkotomter", "järnvägsplan", "miljöriskområde", "samrådsområde", "skydd för ytvattentäkter och enskilda grundvattentäkter (1998:889,40§)", "strandskydd", "stängselgenombrott", "särskild föreskrift för fornlämning", "tillfällig föreskrift för fornlämning", "täkttillstånd", "underhållsskyldighet vattenanläggning", "utökat nybyggnadsförbud enligt väglagen", "vägplan", "bearbetningskoncession", "bearbetningskoncession enligt äldre minerallag", "markanvisning", "utmål enligt gruvlagen", "avgränsat område för fördelning av gatukostnad", "fiskevårdsområde", "utredning om anläggningsavgift för vatten", "viltvårdsområde", "lämning" })

nej
maxHitsKan användas för att begränsa antal resultat. Max 500, default 100.queryintegernej

Svar

Ett MarkreglerandeBestammelsereferensResponse i form av en JSON-array eller XML-lista med referenser till markreglerande bestämmelser, beroende på vilket format som efterfrågades.




GET /referens/beror/{id}

Beskrivning

Hitta markreglerande bestämmelser som berör en viss fastighet eller samfällighet.

Exempel

/referens/beror/12345678-1234-1234-1234-123456789012

Requestparametrar

NamnBeskrivningTypDatatypObligatorisk
idFastighetens eller samfällighetens objektidentitet.pathstring (uuid)ja

Svar

Ett MarkreglerandeBestammelsereferensResponse i form av en JSON-array eller XML-lista med referenser till markreglerande bestämmelser, beroende på vilket format som efterfrågades.




POST /referens/geometri

Beskrivning

Hitta markreglerande bestämmelser inom en given geometri.

Exempel

/referens/geometri

Body, Content-Type: application/xml
<GeometriRequest
    xmlns="http://namespace.lantmateriet.se/distribution/produkter/markreglerandebestammelse/v2">
  <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 MarkreglerandeBestammelsereferensResponse i form av en JSON-array eller XML-lista med referenser till markreglerande bestämmelser, beroende på vilket format som efterfrågades.




GET /beteckning/beteckning

Beskrivning

För användning av autocompletefunktioner. Hämtar stegvis bestämmelsebeteckningar, avgränsade med tecknen kolon, streck och snedstreck.

Exempel

/beteckning/beteckning

/beteckning/beteckning?beteckning=01-IM&maxHits=10

Requestparametrar

NamnBeskrivningTypDatatypObligatorisk
beteckningBestämmelsebeteckning. Om ingen beteckning anges hämtas alla unika beteckningar innan första avgränsningen.querystringnej
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 BeteckningResponse i form av en JSON-array eller XML-lista med bestämmelsebeteckningar, beroende på vilket format som efterfrågades.




GET /beteckning/objektidentitet

Beskrivning

För användning av autocompletefunktioner. Efter att GET /betckning/beteckning har använts för att hitta en bestämmelsebeteckning så kan denna ingång användas för att hämta bestämmelsens objektidentitet.

Exempel

/beteckning/objektidentitet?beteckning=2501-ABC%3AXYZ

Requestparametrar

NamnBeskrivningTypDatatypObligatorisk
beteckningBestämmelsebeteckning.querystringja
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 BeteckningResponse i form av en JSON-array eller XML-lista med bestämmelsebeteckningar, 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 markreglerande bestämmelse med angiven identifierare. 250 idn kan anges i en fråga.

Properties

NamnBeskrivningTypMultiplicitet
idBestämmelsens objektidentitet.string (uuid)1..*

Exempel

XML
<IdRequest
    xmlns="http://namespace.lantmateriet.se/distribution/produkter/markreglerandebestammelse/v2">
  <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 markreglerande bestämmelser 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
Precision för repeterande koordinatpar0.001

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/markreglerandebestammelse/v2">
  <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
}

Svar

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

GET /referens

Requestparametern match har utökats med contains.

Det innebär att vid sökning med en alternativ identitet kan du hitta markreglerande bestämmelse med del av en alternativ identitet.