Teknisk beskrivning

Gränssnittsdefinition

Åtkomstpunkt

Verifiering: https://api-ver.lantmateriet.se/distribution/produkter/registerbeteckning/v5

Produktion: https://api.lantmateriet.se/distribution/produkter/registerbeteckning/v5

Schema

XML: http://namespace.lantmateriet.se/distribution/produkter/registerbeteckning/v5/registerbeteckning-5.0.0.xsd

JSON: http://namespace.lantmateriet.se/distribution/produkter/registerbeteckning/v5/registerbeteckning-5.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:

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

Registerbeteckning

Hämta hela registerbeteckningar.

Operation	Beskrivning
`GET /{id}`	Hämta en registerbeteckning med id.
`POST /`	Hämta en eller flera registerbeteckningar med id.
`GET /namn`	Hämta en registerbeteckning med dess fulla namn.
`POST /namn`	Hämta en eller flera registerbeteckningar med deras fulla namn.
`GET /tillhor/{id}`	Hämta en registerbeteckning med registerenhets- eller gemensamhetsanläggningsid.
`GET /punkt`	Hämta registerbeteckning med koordinat.

Referens

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

Operation	Beskrivning
`GET /referens/fritext`	Hitta registerbeteckningar med en fritextsökning.
`POST /referens/geometri`	Hitta registerbeteckningar med en geometri.

Beteckning

För användning av autocompletefunktioner. Hämtar stegvis registerbeteckningar och slutligen en registerbeteckningsreferens, allteftersom söktexten fylls i.

Operation	Beskrivning
`GET /beteckning/beteckning`	Autocompletefunktion för att hitta registerbeteckningar.
`GET /beteckning/referens`	Hämtar registerenhetsreferens från dess fulla namn.
`POST /beteckning/status`	Hämtar status på beteckningar och dess tillhörande fastigheter.

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 registerbeteckning med id.

Exempel

/12345678-1234-1234-1234-123456789012?srid=3006

Requestparametrar

Namn	Beskrivning	Typ	Datatyp	Obligatorisk
id	Registerbeteckningens identitet.	path	string (uuid)	ja
srid	Referenssystem för geometrier. Default: `3006`.	query	integer	nej

Svar

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

POST /

Beskrivning

Hämta en eller flera registerbeteckningar med id. 250 id:n kan skickas in i samma fråga.

Exempel

/?srid=3006

Body, Content-Type: application/xml

<IdRequest
    xmlns="http://namespace.lantmateriet.se/distribution/produkter/registerbeteckning/v5">
  <id>12345678-0000-0000-0001-123456789012</id>
  <id>12345678-0000-0000-0002-123456789012</id>
</IdRequest>

Body, Content-Type: application/json

["12345678-0000-0000-0001-123456789012", "12345678-0000-0000-0002-123456789012"]

Requestparametrar

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

Namn	Beskrivning	Typ	Datatyp	Obligatorisk
srid	Referenssystem för geometrier. Default: `3006`.	query	integer	nej

Svar

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

GET /namn

Beskrivning

Hämta en registerbeteckning med dess fulla namn. Möjlighet att hämta beteckningsserier genom kommaseparerad lista och/eller intervall av block och enhet

Exempel

/namn?namn=gävle olsbacka 42:1, 45:1-6

Requestparametrar

Namn	Beskrivning	Typ	Datatyp	Obligatorisk
namn	Registerbeteckningens namn.	query	string	ja
srid	Referenssystem för geometrier. Default: `3006`.	query	integer	nej

Svar

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

POST /namn

Beskrivning

Hämta en eller flera registerbeteckningar med deras fulla namn. 250 id:n kan skickas in i samma fråga.

Exempel

/namn?srid=3006

Body, Content-Type: application/xml

<NamnRequest
    xmlns="http://namespace.lantmateriet.se/distribution/produkter/registerbeteckning/v5">
  <namn>gävle olsbacka 45:6</namn>
  <namn>GÄVLE OLSBACKA 45:7</namn>
</NamnRequest>

Body, Content-Type: application/json

["gävle olsbacka 45:6", "GÄVLE OLSBACKA 45:7"]

Requestparametrar

Body: NamnRequest - ett objekt innehållande en lista med beteckningar.

Namn	Beskrivning	Typ	Datatyp	Obligatorisk
srid	Referenssystem för geometrier. Default: `3006`.	query	integer	nej

Svar

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

GET /tillhor/{id}

Beskrivning

Hämta en registerbeteckning med objektidentiteten för den registerenhet eller gemensamhetsanläggning den tillhör.

Exempel

/tillhor/12345678-1234-1234-1234-123456789012

Requestparametrar

Namn	Beskrivning	Typ	Datatyp	Obligatorisk
id	Registerenhetens id i form av ett UUID.	path	string (uuid)	ja
srid	Referenssystem för geometrier. Default: `3006`.	query	integer	nej

Svar

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

GET /punkt

Beskrivning

Hämtar beteckningar för registerenheter vars yta träffas av angiven punkt.

Exempel

/punkt?punktSrid=3006&koordinater=6728782.15,616919.80&srid=3006

Requestparametrar

Namn	Beskrivning	Typ	Datatyp	Obligatorisk
punktSrid	Vilket referenssystem punkten anges i. Default: `3006`.	query	integer	nej
koordinater	Punktens koordinater, enligt ordningen northing, easting, separerade med ett kommatecken.	query	decimal	ja
srid	Referenssystem för geometrier. Default: `3006`.	query	integer	nej

Svar

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

GET /referens/fritext

Beskrivning

Hämta referenser till registerbeteckningar genom en textsökning på beteckningen.

Exempel

/referens/fritext?beteckning=gävle s:&maxHits=15

/referens/fritext?beteckning=olsba gävle&status=gällande,reserverad

/referens/fritext?beteckning=olsba gävle&kommunkod=2180

/referens/fritext?beteckning=olsba gävle&lankod=21

Requestparametrar

Namn	Beskrivning	Typ	Datatyp	Obligatorisk
beteckning	En söksträng med 3 - 300 tecken.	query	string	ja
kommunkod	Kommunkod, fyrsiffrig kod enligt Rikets indelningar. Får ej kombineras med `lankod`.	query	string	nej
lankod	Länskod, tvåsiffrig kod enligt Rikets indelningar. Får ej kombineras med `kommunkod`.	query	string	nej
status	Filtrera resultatet till beteckningar med given/givna statusar. Statusar: `ledig`, `reserverad` och `spärrad` ger inga resultat vid kombination med parametern `objektstatus`.	query	string[] (x ∈ { "gällande", "ledig", "omregistrerad", "reserverad", "spärrad" })	nej
objektstatus	Kan användas för att begränsa svaret till att visa enbart beteckningar för registerenheter och gemensamhetsanläggningar med vald status. `objektstatus` ger inga resultat vid kombination med parametern `status` för värden: `ledig`, `reserverad` och `spärrad`.	query	string (x ∈ { "levande", "avregistrerad" })	nej
maxHits	Kan användas för att begränsa antal resultat. Max `7500`, default `100`.	query	integer	nej

Svar

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

POST /referens/geometri

Beskrivning

Hämta referenser till beteckningar vars registerenhets yta vidrör given geometri.

Exempel

/referens/geometri?status=gällande

Body, Content-Type: application/xml

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

Namn	Beskrivning	Typ	Datatyp	Obligatorisk
status	Filtrera resultatet till beteckningar med given/givna statusar.	query	string[] (x ∈ { "gällande", "ledig", "omregistrerad", "reserverad", "spärrad" })	nej

Svar

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

GET /beteckning/beteckning

Beskrivning

För användning av autocompletefunktioner. Hämtar stegvis beteckningar och slutligen en registerbeteckningsreferens, allteftersom söktexten fylls i.

Den stegvisa sökningen funkar på följande vis:

Beteckning	Resultat
(tom)	Alla registerområden
"g"	Alla registerområden som börjar på g
"gävle " (med mellanslag på slutet)	Alla trakter i Gävle
"gävle ol"	Alla trakter i Gävle som börjar på ol
"gävle olsbacka " (med mellanslag på slutet)	Alla beteckningar i Olsbacka i Gävle
"gävle olsbacka 45:"	Alla beteckningar i block 45 i Olsbaka i Gävle
"gävle lantmäterigatan 45:6" till `GET /beteckning/referens`	Registerbeteckningsreferens till Gävle Olsbacka 45:6

Exempel

/beteckning/beteckning

/beteckning/beteckning?beteckning=gävle olsbacka &maxHits=20

/beteckning/beteckning?beteckning=gävle olsbacka 45&status=gällande,omregistrerad

Requestparametrar

Namn	Beskrivning	Typ	Datatyp	Obligatorisk
beteckning	Registerbeteckning i ordningen <registerområde>, <trakt>, <block>, <enhet>	query	string	nej
maxHits	Kan användas för att begränsa svaret. Ange ett värde mindre eller lika med 0 för obegränsat antal. Default `100`.	query	integer	nej
status	Kan användas för att begränsa svaret till att visa enbart registerbeteckningar med valda statusar.	query	string[] (x ∈ { "gällande", "ledig", "omregistrerad", "reserverad", "spärrad" })	nej
objektstatus	Kan användas för att begränsa svaret till att visa enbart beteckningar för registerenheter och gemensamhetsanläggningar med vald status.	query	string (x ∈ { "levande", "avregistrerad" })	nej

Svar

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

GET /beteckning/referens

Beskrivning

För användning av autocompletefunktioner. Hämtar registerbeteckningsreferens från dess fulla beteckning.

Exempel

/beteckning/referens?beteckning=gävle olsbacka 45&status=gällande,omregistrerad

Requestparametrar

Namn	Beskrivning	Typ	Datatyp	Obligatorisk
beteckning	Registerbeteckning i ordningen <registerområde>, <trakt>, <block>, <enhet>	query	string	ja
maxHits	Kan användas för att begränsa svaret. Ange ett värde mindre eller lika med 0 för obegränsat antal. Default `100`.	query	integer	nej
status	Kan användas för att begränsa svaret till att visa enbart registerbeteckningar med valda statusar.	query	string[] (x ∈ { "gällande", "ledig", "omregistrerad", "reserverad", "spärrad" })	nej
objektstatus	Kan användas för att begränsa svaret till att visa enbart beteckningar för registerenheter och gemensamhetsanläggningar med vald status.	query	string (x ∈ { "levande", "avregistrerad" })	nej

Svar

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

POST /beteckning/status

Beskrivning

Hämtar status på beteckningar och dess tillhörande registerenhet eller gemensamhetsanläggning.

Exempel

/beteckning/status

Body, Content-Type: application/xml

<NamnRequest
   xmlns="http://namespace.lantmateriet.se/distribution/produkter/registerbeteckning/v5">
   <namn>GÄVLE OLSBACKA 45:2</namn>
   <namn>GÄVLE OLSBACKA 45:4</namn>
   <namn>GÄVLE OLSBACKA 45:5</namn>
   <namn>GÄVLE OLSBACKA 45:6</namn>
</NamnRequest>

Body, Content-Type: application/json

[
   "GÄVLE OLSBACKA 45:2",
   "GÄVLE OLSBACKA 45:4",
   "GÄVLE OLSBACKA 45:5",
   "GÄVLE OLSBACKA 45:6"
]

Requestparametrar

Body: NamnRequest - ett objekt innehållande en lista med beteckningar.

Svar

Ett StatusResponse i form av en JSON-array eller XML-lista med beteckningar och deras status, beroende på vilket format som efterfrågades och värdet på match-parametern.

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 registerbeteckning med angiven identifierare. 250 idn kan anges i en fråga.

Properties

Namn	Beskrivning	Typ	Multiplicitet
id	Registerbetckningens identitet.	string (uuid)	1..*

Exempel

XML

<IdRequest
    xmlns="http://namespace.lantmateriet.se/distribution/produkter/registerbeteckning/v5">
  <id>12345678-0000-0000-0001-123456789012</id>
  <id>12345678-0000-0000-0002-123456789012</id>
</IdRequest>

JSON

["12345678-0000-0000-0001-123456789012", "12345678-0000-0000-0002-123456789012"]

NamnRequest

Hämta registerbeteckning med dess fulla namn. 250 namn kan anges i en fråga.

Properties

Namn	Beskrivning	Typ	Multiplicitet
namn	Registerbetckningens namn.	string	1..*

Exempel

XML

<NamnRequest
    xmlns="http://namespace.lantmateriet.se/distribution/produkter/registerbeteckning/v5">
  <namn>gävle olsbacka 45:6</namn>
  <namn>GÄVLE OLSBACKA 45:7</namn>
</NamnRequest>

JSON

["gävle olsbacka 45:6", "GÄVLE OLSBACKA 45:7"]

GeometriRequest

Hitta beteckningar vars registerenhets yta vidrör given geometri. Vissa begränsningar finns:

Begränsning	Maxvärde
Antal punkter i en `MultiPoint`.	1 000 st
Antal brytpunkter i en `LineString` eller `MultiCurve`.	10 000 st
Antal brytpunkter i en `Polygon` eller `MultiSurface`.	10 000 st
Längd på en `LineString` eller sammanlagd längd på en `MultiCurve`.	500 000 m
Area för en `Polygon` eller sammanlagd area för en `MultiSurface`.	30 000 000 m ²
Omkrets på en `Polygon` eller sammanlagd omkrets på en `MultiSurface`.	1 000 000 m

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/registerbeteckning/v5">
  <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

RegisterbeteckningResponse

Behållare för sökningens resultat - ingen, en eller flera sökträffar av typen Registerbeteckning, AldreRegisterbeteckning eller AldreTidigareRegisterbeteckning.

Properties

Namn	Beskrivning	Typ	Multiplicitet
Beteckning	Behållare för en registerenhets eller gemensamhetsanläggnings beteckningar	Beteckning	0..*

Exempel

XML

<RegisterbeteckningResponse gml:id="response"
    xmlns="http://namespace.lantmateriet.se/distribution/produkter/registerbeteckning/v5"
    xmlns:gml="http://www.opengis.net/gml/3.2">
  <gml:boundedBy>
    <gml:Envelope srsName="urn:ogc:def:crs:EPSG::3006">
      <gml:lowerCorner>6727464.556 616432.667</gml:lowerCorner>
      <gml:upperCorner>6727586.372 616628.854</gml:upperCorner>
    </gml:Envelope>
  </gml:boundedBy>
  <RegisterbeteckningMember>
    <Beteckning gml:id="ID_2d4f6b8d-f2b4-6f8b-d2f4-6d8f0b2d4f6b">
      ...
    </Beteckning>
  </RegisterbeteckningMember>
  <RegisterbeteckningMember>
    <Beteckning gml:id="ID_d4f6b8d0-2b4d-f8b0-2f4b-d8f0b2d4f6b8">
      ...
    </Beteckning>
  </RegisterbeteckningMember>
</RegisterbeteckningResponse>

JSON

{
  "type" : "FeatureCollection",
  "crs" : {
    "type" : "name",
    "properties" : {
      "name" : "urn:ogc:def:crs:EPSG::3006"
    }
  },
  "bbox" : [616432.667, 6727464.556, 616628.854, 6727586.372],
  "features" : [
    {
      "type" : "Feature",
      ...
    },
    {
      "type" : "Feature",
      ...
    }
  ]
}

Beteckning

Properties

Namn	Beskrivning	Typ	Multiplicitet
Registerenhetsreferens	Registerenheten som beteckningen hör till. `Registerenhetsreferens` och `Gemensamhetsanlaggningsreferens` är ömsesidigt uteslutande om information finns.	Registerenhetsreferens	0..1
Gemensamhetsanlaggningsreferens	Gemensamhetsanläggningen som beteckningen hör till. `Registerenhetsreferens` och `Gemensamhetsanlaggningsreferens` är ömsesidigt uteslutande om information finns.	Gemensamhetsanlaggningsreferens	0..1
Registerbeteckning	Registerenhetsbeteckning består av registerområde, trakt- eller kvartersnamn, block och enhet. T.ex. Gävle Varva 2:3. Registerenhetsbeteckningen ska vara unik inom sitt registerområde. Endast en beteckning i listan har beteckningsstatus `gällande`.	Registerbeteckning	0..*
AldreRegisterbeteckning	Beteckning innan beteckningsreformen.	AldreRegisterbeteckning	0..*
AldreTidigareRegisterbeteckning	Beteckning innan beteckningsreformen.	AldreTidigareRegisterbeteckning	0..*

Exempel

XML

<Beteckning gml:id="2d4f6b8d-f2b4-6f8b-d2f4-6d8f0b2d4f6b">
  <gml:boundedBy>
    <gml:Envelope srsName="urn:ogc:def:crs:EPSG::3006">
      <gml:lowerCorner>6727464.556 616432.667</gml:lowerCorner>
      <gml:upperCorner>6727586.372 616628.854</gml:upperCorner>
    </gml:Envelope>
  </gml:boundedBy>
  <Registerenhetsreferens>
    ...
  </Registerenhetsreferens>
  <Registerbeteckning>
    ...
  </Registerbeteckning>
  <Registerbeteckning>
    ...
  </Registerbeteckning>
  <AldreRegisterbeteckning>
    ...
  </AldreRegisterbeteckning>
  <AldreRegisterbeteckning>
    ...
  </AldreRegisterbeteckning>
  <AldreTidigareRegisterbeteckning>
    ...
  </AldreTidigareRegisterbeteckning>
  <AldreTidigareRegisterbeteckning>
    ...
  </AldreTidigareRegisterbeteckning>
</Beteckning >

JSON

{
  "type" : "Feature",
  "bbox" : [616432.667, 6727464.556, 616628.854, 6727586.372],
  "geometry" : null,
  "properties" : {
    "gemensamhetsanlaggningsreferens" : {
      ...
    },
    "registerbeteckning" : [
      ...
    ],
    "aldreRegisterbeteckning" : [
      ...
    ],
    "aldreTidigareRegisterbeteckning" : [
      ...
    ]
  }
}

Registerenhetsreferens

Referens till den registerenhet beteckningen hör till.

Properties

Namn	Beskrivning	Typ	Multiplicitet
objektidentitet	Unik identitet (UUID) för varje registerenhet.	string (uuid)	1
objektstatus	Anger om registerenheten är levande eller avregistrerad.	string ( x ∈ { "levande", "avregistrerad" } )	1
typ	Anger om registerenheten är en Fastighet eller Samfällighet.	string ( x ∈ { "Fastighet", "Samfällighet" } )	1
Registerenhetsomrade	Registerenhetens geografiska områden.	Registerenhetsomrade	0..*

Exempel

XML

<Registerenhetsreferens>
  <objektidentitet>12345678-1234-1234-1234-123456789012</objektidentitet>
  <objektstatus>levande</objektstatus>
  <typ>Fastighet</typ>
  <Registerenhetsomrade>
    ...
  </Registerenhetsomrade>
  <Registerenhetsomrade>
    ...
  </Registerenhetsomrade>
</Registerenhetsreferens>

JSON

{
  "objektidentitet": "12345678-1234-1234-1234-123456789012",
  "objektstatus": "levande",
  "typ": "Fastighet",
  "registerenhetsomrade": [
    ...
  ]
}

Registerenhetsomrade

Properties

Namn	Beskrivning	Typ	Multiplicitet
markering	Anger om det var detta område som träffades i en geometrisökning. Default är `false`.	boolean	0..1
omradesnummer	Varje delområde för en fastighet redovisas var för sig med ett områdesnummer.	integer	1
Centralpunktskoordinat	Anger en centralt belägen koordinatsatt punkt inom området.	punkt	0..1

Exempel

XML

<Enhetsomrade markering="true">
  <omradesnummer>1</omradesnummer>
  <Centralpunktskoordinat>
    <gml:Point srsName="urn:ogc:def:crs:EPSG::3006" gml:id="GM_15">
      <gml:pos>6729125.2 500179.0</gml:pos>
    </gml:Point>
  </Centralpunktskoordinat>
</Enhetsomrade>

JSON

{
  "markering": true,
  "omradesnummer" : 1,
  "centralpunktskoordinat": {
    "type": "Point",
    "coordinates": [500179, 6729125.2]
  }
}

Gemensamhetsanlaggningsreferens

Referens till den gemensamhetsanläggning beteckningen hör till.

Properties

Namn	Beskrivning	Typ	Multiplicitet
objektidentitet	Unik identitet (UUID) för varje gemensamhetsanläggning.	string (uuid)	1
objektstatus	Anger om gemensamhetsanläggningen är levande eller avregistrerad.	string ( x ∈ { "levande", "avregistrerad" } )	1

Exempel

XML

<Gemensamhetsanlaggningsreferens>
  <objektidentitet>12345678-1234-1234-1234-123456789012</objektidentitet>
  <objektstatus>levande</objektstatus>
</Gemensamhetsanlaggningsreferens>

JSON

{
  "objektidentitet": "12345678-1234-1234-1234-123456789012",
  "objektstatus": "levande"
}

Registerbeteckning

Properties

Namn	Beskrivning	Typ	Multiplicitet
markering	Anger om det var denna beteckning som efterfrågades vid hämtning på ID eller namn. Default är `false`.	boolean	0..1
objektidentitet	Identitet för registerbeteckningen.	string (uuid)	1
objektversion		integer	1
versionGiltigFran		dateTime	0..1
registeromrade	Varje kommun bildar ett registerområde, med samma namn som kommunen.	string	1
trakt	Ett registerområde är indelat i trakter, Trakt motsvarar i regel bynamnet på landsbygden och stadsdelsnamn eller liknande inom tätort	string	1
block	Underindelningen av trakt är block. En trakt kan ha ett eller flera block. Ett block består av en eller flera fastigheter.	string	0..1
enhet	Fastigheter inom samma block numreras med enhetsnummer.	integer	1
beteckningsstatus	Anger aktuell status för registerbeteckningen.	string ( x ∈ { "gällande", "ledig", "omregistrerad", "reserverad", "spärrad" } )	1
omregistreringsdatum		date	0..1
omregistreringsaktbeteckning		string	0..1
omregistreradTill		string (uuid)	0..1

Exempel

XML

<Registerbeteckning markering="true">
  <objektidentitet>12345678-1234-1234-1234-123456789012</objektidentitet>
  <objektversion>2</objektversion>
  <versionGiltigFran>2022-06-29T17:18:34.123+02:00</versionGiltigFran>
  <registeromrade>GÄVLE</registeromrade>
  <trakt>OLSBACKA</trakt>
  <block>45</block>
  <enhet>6</enhet>
  <beteckningsstatus>gällande</beteckningsstatus>
  <omregistreringsdatum>2022-06-29</omregistreringsdatum>
  <omregistreringsaktbeteckning>AKT-123/HEJ</omregistreringsaktbeteckning>
  <omregistreradTill>12345678-cafe-cafe-cafe-123456789012</omregistreradTill>
</Registerbeteckning>

JSON

{
  "markering": true,
  "objektidentitet": "12345678-1234-1234-1234-123456789012",
  "objektversion": 2,
  "versionGiltigFran": "2022-06-29T17:18:34.123+02:00",
  "registeromrade": "GÄVLE",
  "trakt": "OLSBACKA",
  "block": "45",
  "enhet": 6,
  "beteckningsstatus": "gällande",
  "omregistreringsdatum": "2022-06-29",
  "omregistreringsaktbeteckning": "AKT-123/HEJ",
  "omregistreradTill": "12345678-cafe-cafe-cafe-123456789012"
}

AldreRegisterbeteckning

Properties

Namn	Beskrivning	Typ	Multiplicitet
markering	Anger om det var denna beteckning som efterfrågades vid hämtning på ID eller namn. Default är `false`.	boolean	0..1
objektidentitet	Identitet för registerbeteckningen.	string (uuid)	1
objektversion		integer	1
versionGiltigFran		dateTime	0..1
beteckningsniva1	Anger registerområde är jordregistersocken eller stadsregisterområde.	string	1
beteckningsniva2	Anger trakt (by- eller hemmansnamn) eller ägotrakter (i stad). Varje registerområde är indelat i trakter eller ägotrakter . Vissa beteckningar i stad och då framför allt kvarter saknar ägotrakter och saknar därför "andra ledet" (nivå 2).	string	0..1
beteckningsniva3	Varje trakt är indelad i block och i stad i kvarter eller stadsägor.	string	0..1
beteckningsniva4	Varje block och kvarter är indelat i enheter. Stadsägor har ett eget nummer.	string	1
beteckningsstatus	Anger aktuell status för registerbeteckningen.	string ( x ∈ { "ej entydig", "omregistrerad", "referensbeteckning", "reserverad", "spärrad" } )	1
omregistreradTill		string (uuid)	0..1

Exempel

XML

<AldreRegisterbeteckning markering="true">
  <objektidentitet>12345678-1234-1234-1234-123456789012</objektidentitet>
  <objektversion>2</objektversion>
  <versionGiltigFran>2022-06-29T17:18:34.123+02:00</versionGiltigFran>
  <beteckningsniva1>X-GÄVLE</beteckningsniva1>
  <beteckningsniva2>*</beteckningsniva2>
  <beteckningsniva3>STG</beteckningsniva3>
  <beteckningsniva4>101+102+/103,105/</beteckningsniva4>
  <beteckningsstatus>omregistrerad</beteckningsstatus>
  <omregistreradTill>12345678-cafe-cafe-cafe-123456789012</omregistreradTill> 
</AldreRegisterbeteckning>

JSON

{
  "markering": true,
  "objektidentitet": "12345678-1234-1234-1234-123456789012",
  "objektversion": 2,
  "versionGiltigFran": "2022-06-29T17:18:34.123+02:00",
  "beteckningsniva1": "X-GÄVLE",
  "beteckningsniva2": "*",
  "beteckningsniva3": "STG",
  "beteckningsniva4": "101+102+/103,105/",
  "beteckningsstatus": "omregistrerad",
  "omregistreradTill": "12345678-cafe-cafe-cafe-123456789012"
}

AldreTidigareRegisterbeteckning

Properties

Namn	Beskrivning	Typ	Multiplicitet
markering	Anger om det var denna beteckning som efterfrågades vid hämtning på ID eller namn. Default är `false`.	boolean	0..1
objektidentitet	Identitet för registerbeteckningen.	string (uuid)	1
objektversion		integer	1
versionGiltigFran		dateTime	0..1
beteckningsniva1	Anger registerområde är jordregistersocken eller stadsregisterområde.	string	1
beteckningsniva2	Anger trakt (by- eller hemmansnamn) eller ägotrakter (i stad). Varje registerområde är indelat i trakter eller ägotrakter . Vissa beteckningar i stad och då framför allt kvarter saknar ägotrakter och saknar därför "andra ledet" (nivå 2).	string	0..1
beteckningsniva3	Varje trakt är indelad i block och i stad i kvarter eller stadsägor.	string	0..1
beteckningsniva4	Varje block och kvarter är indelat i enheter. Stadsägor har ett eget nummer.	string	1
omregistreringsdatum	Anger datum när registerenhet omregistrerats.	string	0..1
omregistreringslopnummer	Anger löpnummer för när registerenhet omregistrerats.	integer	0..1
omregistreringsaktbeteckning	Anger beteckning på den akt som innehåller Lantmäterimyndighetens beslut att enheten ska omregistreras.	string	0..1

Exempel

XML

<AldreTidigareRegisterbeteckning markering="true">
  <objektidentitet>12345678-1234-1234-1234-123456789012</objektidentitet>
  <objektversion>2</objektversion>
  <versionGiltigFran>2022-06-29T17:18:34.123+02:00</versionGiltigFran>
  <beteckningsniva1>X-GÄVLE</beteckningsniva1>
  <beteckningsniva2>*</beteckningsniva2>
  <beteckningsniva3>STG</beteckningsniva3>
  <beteckningsniva4>101+102+/103,105/</beteckningsniva4>
  <omregistreringsdatum>19900606</omregistreringsdatum>
  <omregistreringslopnummer>1990157</omregistreringslopnummer>
  <omregistreringsaktbeteckning>1583-700</omregistreringsaktbeteckning>
</AldreRegisterbeteckning>

JSON

{
  "markering": true,
  "objektidentitet": "12345678-1234-1234-1234-123456789012",
  "objektversion": 2,
  "versionGiltigFran": "2022-06-29T17:18:34.123+02:00",
  "beteckningsniva1": "X-GÄVLE",
  "beteckningsniva2": "*",
  "beteckningsniva3": "STG",
  "beteckningsniva4": "101+102+/103,105/",
  "omregistreringsdatum": "19900606",
  "omregistreringslopnummer": 1990157,
  "omregistreringsaktbeteckning": "1583-700",
}

RegisterbeteckningsreferensResponse

Behållare för sökningens resultat - ingen, en eller flera sökträffar av typen Registerbeteckningsreferens.

Properties

Namn	Beskrivning	Typ	Multiplicitet
Registerbeteckningsreferens		Registerbeteckningsreferens	0..*

Exempel

XML

<RegisterbeteckningsreferensResponse
    xmlns="http://namespace.lantmateriet.se/distribution/produkter/registerbeteckning/v5">
  <Registerbeteckningsreferens>
    ...
  </Registerbeteckningsreferens>
  <Registerbeteckningsreferens>
    ...
  </Registerbeteckningsreferens>
</RegisterbeteckningsreferensResponse>

JSON

[
  {
    "objektidentitet": "12345678-0000-0000-0001-123456789012",
    ...
  },
  {
    "objektidentitet": "12345678-0000-0000-0002-123456789012",
    ...
  }
]

Registerbeteckningsreferens

Utgör en förenklad representation av informationen om en registerbeteckning inklusive dess identitet.

Properties

Namn	Beskrivning	Typ	Multiplicitet
objektidentitet	Identitet för registerbeteckningen.	string (uuid)	1
registerenhet	Registerenhetens identitet (UUID). `registerenhet` och `registerenhetstyp` är ömsesidigt uteslutande med `gemensamhetsanlaggning` om information finns.	string (uuid)	0..1
registerenhetstyp	Registerenhetens typ. `registerenhet` och `registerenhetstyp` är ömsesidigt uteslutande med `gemensamhetsanlaggning` om information finns.	string ( x ∈ { "Fastighet", "Samfällighet" } )	0..1
gemensamhetsanlaggning	Gemensamhetsanläggningsens identitet (UUID). `registerenhet` och `registerenhetstyp` är ömsesidigt uteslutande med `gemensamhetsanlaggning` om information finns.	string (uuid)	0..1
beteckning	Beteckningens sammansatta namn t.ex. GÄVLE OLSBACKA 45:6.	string	1

Exempel

XML

<Registerbeteckningsreferens>
  <objektidentitet>12345678-1234-1234-1234-123456789012</objektidentitet>
  <registerenhet>12345678-cafe-cafe-cafe-123456789012</registerenhet>
  <registerenhetstyp>Fastighet</registerenhetstyp>
  <beteckning>GÄVLE OLSBACKA 45:6</beteckning>
</Registerbeteckningsreferens>

JSON

{
  "objektidentitet": "12345678-1234-1234-1234-123456789012",
  "gemensamhetsanlaggning": "12345678-cafe-cafe-cafe-123456789012",
  "beteckning": "GÄVLE OLSBACKA 45:6"
}

BeteckningResponse

Properties

Namn Beskrivning Typ Multiplicitet

beteckning

Matchade delar av registerbeteckningar på formen "<registerområde> <trakt> [<block>:]<enhet>".

beteckning och Registerbeteckningsreferens är ömsesidigt uteslutande.

string

0..*

Registerbeteckningsreferens

Referenser till matchad registerbeteckning.

beteckning och Registerbeteckningsreferens är ömsesidigt uteslutande.

Registerbeteckningsreferens

0..*

Exempel

XML

<BeteckningResponse
    xmlns="http://namespace.lantmateriet.se/distribution/produkter/registerbeteckning/v5">
  <beteckning>GÄLLIVARE</beteckning>
  <beteckning>GÄVLE</beteckning>
</BeteckningResponse>

---

<BeteckningResponse
    xmlns="http://namespace.lantmateriet.se/distribution/produkter/registerbeteckning/v5">
  <Registerbeteckningsreferens>
    ...
  </Registerbeteckningsreferens>
  <Registerbeteckningsreferens>
    ...
  </Registerbeteckningsreferens>
</BeteckningResponse>

JSON

[
  "GÄVLE OLSBACKA",
  "GÄVLE ORSTA"
]

---

[
  {
    "objektidentitet": "12345678-0000-0000-0001-123456789012",
    ...
  },
  {
    "objektidentitet": "12345678-0000-0000-0002-123456789012",
    ...
  }
]

StatusResponse

Properties

Namn	Beskrivning	Typ	Multiplicitet
Status	Statusbehållare.	Status	0..*

Exempel

XML

<StatusResponse
    xmlns="http://namespace.lantmateriet.se/distribution/produkter/registerbeteckning/v5">
  <Status>
    ...
  </Status>
  <Status>
    ...
  </Status>
</Registerbeteckningsreferens>

JSON

[
  {
    "objektidentitet": "12345678-0000-0000-0001-123456789012",
    ...
  },
  {
    "objektidentitet": "12345678-0000-0000-0002-123456789012",
    ...
  }
]

Status

Properties

Namn	Beskrivning	Typ	Multiplicitet
objektidentitet	Identitet för registerbeteckningen.	string (uuid)	1
beteckning	Beteckningens sammansatta namn t.ex. GÄVLE OLSBACKA 45:6.	string	1
beteckningsstatus	Anger aktuell status för registerbeteckningen. `beteckningsstatus` och `aldreBeteckningsstatus` är ömsesidigt uteslutande.	string ( x ∈ { "gällande", "ledig", "omregistrerad", "reserverad", "spärrad" } )	0..1
aldreBeteckningsstatus	Anger aktuell status för registerbeteckningen. `beteckningsstatus` och `aldreBeteckningsstatus` är ömsesidigt uteslutande.	string ( x ∈ { "omregistrerad", "reserverad", "spärrad", "ej entydig", "referensbeteckning" } )	0..1
registerenhetsstatus	Anger om registerenheten är levande eller avregistrerad. `registerenhetsstatus` och `gemensamhetsanlaggningsstatus` är ömsesidigt uteslutande om information finns.	string ( x ∈ { "levande", "avregistrerad" } )	0..1
gemensamhetsanlaggningsstatus	Anger om gemensamhetsanläggningen är levande eller avregistrerad. `registerenhetsstatus` och `gemensamhetsanlaggningsstatus` är ömsesidigt uteslutande om information finns.	string ( x ∈ { "levande", "avregistrerad" } )	0..1

Exempel

XML

<Status>
  <objektidentitet>12345678-1234-1234-1234-123456789012</objektidentitet>
  <beteckning>GÄVLE OLSBACKA 45:6</beteckning>
  <beteckningsstatus>gällande</beteckningsstatus>
  <registerenhetsstatus>avregistrerad</registerenhetsstatus>
</Status>

JSON

{
  "objektidentitet": "12345678-1234-1234-1234-123456789012",
  "beteckning": "GÄVLE OLSBACKA 45:6",
  "aldreBeteckningsstatus": "omregistrerad",
  "gemensamhetsanlaggningsstatus": "levande"
}

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