Teknisk beskrivning

Gränssnittsdefinition

Åtkomstpunkt

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

Produktion: https://api.lantmateriet.se/distribution/produkter/rattighet/v2.1

Schema

XML: https://namespace.lantmateriet.se/distribution/produkter/rattighet/v2.1/rattighet-2.1.0.xsd

JSON: https://namespace.lantmateriet.se/distribution/produkter/rattighet/v2.1/rattighet-2.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:

Felmeddelande

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

Sammanfattning

Rättighet

Hämta hela - eller delmängder av - rättigheter.

Referens

Hämta referenser till rättigheter, med etikett och id.

Beteckning

För användning av autocompletefunktioner. Hämtar stegvis rättighetsbeteckningar och slutligen en rättighetsreferens.

Health

Operationer

GET /{id}

Beskrivning

Hämta en rättighet med objektidentitet. Delar av rättigheten kan hämtas genom includeData-parametern.

Exempel

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

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

Requestparametrar

Svar

Ett RattighetResponse i form av en GeoJSON eller GML FeatureCollection med rättighet, beroende på vilket format som efterfrågades.

GET /

Beskrivning

Hämta en rättighet med beteckning. Delar av rättigheten kan hämtas genom includeData-parametern.

Exempel

/?lansbokstav=A&beteckning=123-321/213.17

/?lansbokstav=A&beteckning=123-321/213.17&includeData=basinformation,historik

Requestparametrar

Svar

Ett RattighetResponse i form av en GeoJSON eller GML FeatureCollection med rättighet, beroende på vilket format som efterfrågades.

POST /

Beskrivning

Hämta en eller flera rättigheter med id eller beteckning. Antingen 250 id:n eller 250 beteckningar kan som mest skickas in i samma fråga. Delar av rättigheten kan hämtas genom includeData-parametern.

Exempel id-fråga

/?includeData=total

<IdRequest
    xmlns="http://namespace.lantmateriet.se/distribution/produkter/rattighet/v2.1">
  <id>12345678-1234-1234-1234-123456789012</id>
  <id>10000008-cafe-cafe-cafe-100000000002</id>
</IdRequest>

{
  "id": ["12345678-1234-1234-1234-123456789012", "10000008-cafe-cafe-cafe-100000000002"]
}

Exempel beteckningsfråga:

/?includeData=total

<IdRequest
    xmlns="http://namespace.lantmateriet.se/distribution/produkter/rattighet/v2.1">
  <rattighetsbeteckning>
    <lansbokstav>A</lansbokstav>
    <beteckning>123-321/231.17</beteckning>
  </rattighetsbeteckning>
  <rattighetsbeteckning>
    <lansbokstav>B</lansbokstav>
    <beteckning>321-123/132.71</beteckning>
  </rattighetsbeteckning>
</IdRequest>

{
  "rattighetsbeteckning": [
    {
      "lansbokstav": "A",
      "beteckning": "123-321/231.17"
    },
    {
      "lansbokstav": "B",
      "beteckning": "321-123/132.71"
    }
  ]
}

Requestparametrar

Body: IdRequest - ett objekt innehållandes en lista med objektidentiteter eller rättighetsbeteckningar.

Svar

Ett RattighetResponse i form av en GeoJSON eller GML FeatureCollection med rättighet, beroende på vilket format som efterfrågades.

POST /referens/geometri

Beskrivning

Hämta referenser till rättigheter inom en given geometri.

Exempel

/referens/geometri

<GeometriRequest
    xmlns="http://namespace.lantmateriet.se/distribution/produkter/rattighet/v2.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>

{
  "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 RattighetsreferensResponse i form av en JSON-array eller XML-lista med rättighetsreferenser, beroende på vilket format som efterfrågades.

GET /referens/beror/{berörkrets}

Beskrivning

Hämta referenser till rättigheter med en given registerenhet eller gemensamhetsanläggning.

Exempel

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

Requestparametrar

Svar

Ett RattighetsreferensResponse i form av en JSON-array eller XML-lista med rättighetsreferenser, beroende på vilket format som efterfrågades.

GET /referens/ledningshavare

Beskrivning

Hämta referenser till rättigheter genom att söka på ledningshavare.

Exempel

/referens/ledningshavare?ledningshavare=Lantm&match=startsWith

Requestparametrar

Svar

Ett RattighetsreferensResponse i form av en JSON-array eller XML-lista med rättighetsreferenser, beroende på vilket format som efterfrågades.

GET /beteckning/aktbeteckning

Beskrivning

Ingång för att stegvis finna aktbeteckningar. Aktbeteckningar är uppdelade med tecknen ":", "/" samt "-". Ett resultat som slutar med en punkt är en komplett aktbeteckning. Sökningen fungerar på följande vis:

Exempel

/beteckning/aktbeteckning?aktbeteckning=01-23&maxHits=40

Requestparametrar

Svar

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

GET /beteckning/rattighetsnummer

Beskrivning

Ingång för att stegvis finna rättighetsnummer utifrån en aktbeteckning. Sökningen fungerar på följande vis:

Exempel

/beteckning/rattighetsnummer?aktbeteckning=01-23-45&rattighetsnummer=3

Requestparametrar

Svar

Ett BeteckningResponse med rättighetsnummer i form av en JSON-array eller XML-lista, beroende på vilket format som efterfrågades.

GET /beteckning/objektidentitet

Beskrivning

Hämtar referenser till samtliga rättigheter med en viss aktbeteckning och rättighetsnummer.

Exempel

/beteckning/objektidentitet?aktbeteckning=01-23-45&rattighetsnummer=37

Requestparametrar

Svar

Ett BeteckningResponse med objektidentiteter i form av en JSON-array eller XML-lista, 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 rättighet med angiven identifierare. Antingen objektidentitet eller rättighetsbeteckning kan anges. 250 id:n kan anges i en fråga.

Properties

Exempel med objektidentitet

<IdRequest
    xmlns="http://namespace.lantmateriet.se/distribution/produkter/rattighet/v2.1">
  <id>12345678-1234-1234-1234-123456789012</id>
  <id>10000008-cafe-cafe-cafe-100000000002</id>
</IdRequest>

{
  "id": ["12345678-1234-1234-1234-123456789012", "10000008-cafe-cafe-cafe-100000000002"]
}

Exempel med rättighetsbeteckning

<IdRequest
    xmlns="http://namespace.lantmateriet.se/distribution/produkter/rattighet/v2.1">
  <rattighetsbeteckning>
    ...
  </rattighetsbeteckning>
  <rattighetsbeteckning>
    ...
  </rattighetsbeteckning>
</IdRequest>

{
  "rattighetsbeteckning": [
    {
      ...
    },
    {
      ...
    }
  ]
}

Rattighetsbeteckning

Anger en rättighetsbeteckning.

Properties

Exempel

<Rattighetsbeteckning
    xmlns="http://namespace.lantmateriet.se/distribution/produkter/rattighet/v2.1">
  <lansbokstav>A</lansbokstav>
  <beteckning>01-23/74.11</beteckning>
</IdRequest>

{
  "lansbokstav": "A",
  "beteckning": "01-23/74.11"
}

GeometriRequest

Hitta rättigheter inom geometri. Vissa begränsningar finns:

Properties

Exempel

<GeometriRequest
    xmlns="http://namespace.lantmateriet.se/distribution/produkter/rattighet/v2.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>

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