Teknisk beskrivning

Gränssnittsdefinition

Åtkomstpunkt

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

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

Schema

XML: http://namespace.lantmateriet.se/distribution/produkter/gemensamhetsanlaggning/v2.1/gemensamhetsanlaggning-2.1.1.xsd

JSON: http://namespace.lantmateriet.se/distribution/produkter/gemensamhetsanlaggning/v2.1/gemensamhetsanlaggning-2.1.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:

Referenssystem	SRID
SWEREF 99 TM	3006
SWEREF 99 12 00	3007
SWEREF 99 13 30	3008
SWEREF 99 14 15	3012
SWEREF 99 15 00	3009
SWEREF 99 15 45	3013
SWEREF 99 16 30	3010
SWEREF 99 17 15	3014
SWEREF 99 18 00	3011
SWEREF 99 18 45	3015
SWEREF 99 20 15	3016
SWEREF 99 21 45	3017
SWEREF 99 23 15	3018

Felmeddelande

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

Sammanfattning

Gemensamhetsanläggning

Hämta hela - eller delmängder av - gemensamhetsanläggningar.

Operation	Beskrivning
`GET /{id}`	Hämta en gemensamhetsanläggning med id.
`POST /`	Hämta en eller flera gemensamhetsanläggningar med id.

Referens

Hämta referenser till gemensamhetsanläggningar, med etikett och id.

Operation	Beskrivning
POST /referens/geometri	Hitta gemensamhetsanläggningar med en geometri.
GET /referens/delagande	Hitta gemensamhetsanläggningar med delägande id
GET /referens/aktbeteckning	Hitta gemensamhetsanläggningar 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 gemensamhetsanläggning med objektidentitet. Delar av gemensamhetsanläggningen kan hämtas genom includeData-parametern.

Exempel

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

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

Requestparametrar

Namn	Beskrivning	Typ	Datatyp	Obligatorisk
id	Gemensamhetsanläggningens objektidentitet.	path	string	ja
includeData	Vad i gemensamhetsanläggningen 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 `Gemensamhetsanlaggningsattribut,` `PagaendeArende`, `Registerenhetsanmarkning`, Gemensamhetsanlaggningsanmarkning samt Registerbeteckning. atgard - hämtar Fastighetsatgard. `beteckningForeReformen` - hämtar `AldreTidigareRegisterbeteckning`. `andel` - hämtar `DelI` och `Delagare`. geometri - hämtar Geometri. `total` - hämtar allt.	query	string[] (x ∈ { "basinformation", "atgard", "beteckningForeReformen", "andel", "geometri", "total" })	nej
srid	Referenssystem för geometrier. Default: `3006`.	query	integer	nej
instant	Endast för internt bruk. För vilken tid informationen ska hämtas. Som default hämtas den senaste versionen av informationen.	query	integer	nej

Svar

Ett GemensamhetsanlaggningResponse i form av en GeoJSON eller GML FeatureCollection med gemensamhetsanläggning, beroende på vilket format som efterfrågades.

POST /

Beskrivning

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

Exempel

/?includeData=total

Body, Content-Type: application/xml

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

Namn Beskrivning Typ Datatyp Obligatorisk

includeData

Vad i gemensamhetsanläggningen 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 Gemensamhetsanlaggningsattribut, PagaendeArende, Registerenhetsanmarkning, Gemensamhetsanlaggningsanmarkning samt Registerbeteckning.
atgard - hämtar Fastighetsatgard.
beteckningForeReformen - hämtar AldreTidigareRegisterbeteckning.
andel - hämtar DelI och Delagare.
geometri - hämtar Geometri.
total - hämtar allt.

query

string[] (x ∈ { "basinformation", "atgard", "beteckningForeReformen", "andel", "geometri", "total" })

nej

srid Referenssystem för geometrier. Default: 3006. query integer nej

instant Endast för internt bruk. För vilken tid informationen ska hämtas. Som default hämtas den senaste versionen av informationen. query integer nej

Svar

Ett GemensamhetsanlaggningResponse i form av en GeoJSON eller GML FeatureCollection med gemensamhetsanläggningar, beroende på vilket format som efterfrågades.

POST /referens/geometri

Beskrivning

Hämta referenser till gemensamhetsanläggningar inom en given geometri.

Exempel

/referens/geometri

Body, Content-Type: application/xml

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

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 GemensamhetsanlaggningsreferensResponse i form av en JSON-array eller XML-lista med gemensamhetsanläggningsreferenser, 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.

GET /referens/delagande

Beskrivning

Hämta referenser till gemensamhetsanläggning med id för delägande registerenhet

Exempel

/referens/delagande/12345678-1234-1234-1234-123456789012

Namn	Beskrivning	Typ	Datatyp	Obligatorisk
id	Objektidentitet för delägare.	path	string	ja

Svar

Ett GemensamhetsanlaggningsreferensResponse i form av en JSON-array eller XML-lista med gemensamhetsanläggningsreferenser, beroende på vilket format som efterfrågades

GET /referens/aktbeteckning

Beskrivning

Hämta referenser till gemensamhetsanläggning med aktbeteckning.

Exempel

/referens/aktbeteckning?aktbeteckning=28-93:682

Namn	Beskrivning	Typ	Datatyp	Obligatorisk
aktbeteckning	Aktbeteckning	query	string	ja

Svar

Ett GemensamhetsanlaggningsreferensResponse i form av en JSON-array eller XML-lista med gemensamhetsanläggningsreferenser, beroende på vilket format som efterfrågades.

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

Gemensamhetsanlaggning.avregistreringsaktbeteckning
Fastighetsatgard.aktbeteckning
Registerbeteckning.omregistreringsaktbeteckning
AldreTidigareRegisterbeteckning.omregistreringsaktbeteckning

Datatyper

Frågor

IdRequest

Hämta gemensamhetsanläggning med angiven identifierare. 250 id:n kan anges i en fråga.

Properties

Namn	Beskrivning	Typ	Multiplicitet
id	Gemensamhetsanläggningens objektidentitet.	string	1..*

Exempel

XML

<IdRequest
    xmlns="http://namespace.lantmateriet.se/distribution/produkter/gemensamhetsanlaggning/v2.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 gemensamhetsanläggningar inom geometri. Vissa begränsningar finns:

Begränsning	Maxvä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²
Omkrets på en `Polygon` eller sammanlagd omkrets på en `MultiSurface`.	200 000 m
`Precision för repeterande koordinatpar.`	`0.001`

Properties

Namn	Beskrivning	Typ	Multiplicitet
Geometri	En GML- eller GeoJSON-geometri. GML-geometrier ska följa Lantmäteriets GML 3.2.1-profil.	geometri	1
buffer	Område runt den angivna geometrin som ska ingå i sökträffen.	integer	0..1

Exempel

XML

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

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

Namn	Beskrivning	Typ	Multiplicitet
up	Anger status för tjänsten.	boolean	1

Exempel

JSON

{"up": true}

Felmeddelande

Fault

Properties

Namn	Beskrivning	Typ	Multiplicitet
code	HTTP-felkod.	integer	1
reason	Textöversättning av felkod	string	1
errors	Mer detaljerad felbeskrivning	string	0..*

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

Gränssnittsdefinition

Åtkomstpunkt

Schema

Format

Referenssystem

Felmeddelande

Sammanfattning

Gemensamhetsanläggning

Referens

Hälsokontroll

Operationer

GET /{id}

Beskrivning

Exempel

Requestparametrar

Svar

POST /

Beskrivning

Exempel

Requestparametrar

Svar

POST /referens/geometri

Beskrivning

Exempel

Requestparametrar

Svar

GET /health

GET /referens/delagande

Beskrivning

Exempel

Svar

GET /referens/aktbeteckning

Beskrivning

Exempel

Svar

Datatyper

Frågor

IdRequest

Properties

Exempel

GeometriRequest

Properties

Exempel

HealthResponse

Felmeddelande

Fault

Properties

Exempel

Versionshistorik, Gemensamhetsanläggning Direkt