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:

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.

Referens

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

Beteckning

För användning av autocompletefunktioner. Hämtar stegvis bestämmelsebeteckningar och slutligen objektidentiteter, 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 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

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

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

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

Requestparametrar

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

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

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

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

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

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

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

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

Exempel

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

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

GeometriRequest

Hitta markreglerande bestämmelser inom geometri. Vissa begränsningar finns:

Properties

Exempel

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

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

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