Teknisk beskrivning

Gränssnittsdefinition

Åtkomstpunkt

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

Produktion: https://api.lantmateriet.se/distribution/produkter/byggnad/v3

Schema

XML: http://namespace.lantmateriet.se/distribution/produkter/byggnad/v3/byggnad-3.0.0.xsd

JSON: http://namespace.lantmateriet.se/distribution/produkter/byggnad/v3/byggnad-3.0.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

Byggnad

Hämta hela - eller delmängder av - byggnader.

Referens

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

Operationer

GET /{id}

Beskrivning

Hämta en byggnad med id. Delar av byggnaden kan hämtas genom includeData-parametern.

Exempel

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

Requestparametrar

Svar

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

POST /

Beskrivning

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

Exempel

/?includeData=total

<IdRequest
    xmlns="http://namespace.lantmateriet.se/distribution/produkter/byggnad/v3">
  <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 ByggnadResponse i form av en GeoJSON eller GML FeatureCollection med adresser, beroende på vilket format som efterfrågades.

GET /referens/beror/{id}

Beskrivning

Hämta referenser till byggnader med en registerenhets eller gemensamhetsanläggnings objektidentitet.

Exempel

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

Requestparametrar

Svar

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

POST /referens/geometri

Beskrivning

Hämta referenser till byggnader inom en given geometri.

Exempel

/referens/geometri

<GeometriRequest
    xmlns="http://namespace.lantmateriet.se/distribution/produkter/byggnad/v3">
  <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 ByggnadsreferensResponse i form av en JSON-array eller XML-lista med byggnadsreferenser, beroende på vilket format som efterfrågades.

Datatyper

Frågor

IdRequest

Hämta byggnad med angiven identifierare. 250 idn kan anges i en fråga.

Properties

Exempel

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

Properties

Exempel

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

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