Gränssnittsdefinition

Åtkomstpunkt

Verifiering	`https://api-ver.lantmateriet.se/distribution/produkter/inskrivning/v3`
Produktion	`https://api.lantmateriet.se/distribution/produkter/inskrivning/v3`

Schema

XML	`http://namespace.lantmateriet.se/distribution/produkter/inskrivning/v3/inskrivning-3.0.0.xsd`
JSON	`http://namespace.lantmateriet.se/distribution/produkter/inskrivning/v3/inskrivning-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.

Felmeddelande

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

Sammanfattning

Inskrivning

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

Operation	Beskrivning
`GET /{id}`	Hämta en inskrivning med id för inskrivningsfastighet.
`POST /`	Hämta en eller flera inskrivningar med id.
`GET /beror/{id}`	Hämta en inskrivning med fastighetsid.
`POST /beror`	Hämta en eller flera inskrivningar med fastighetsid.

Referens

Hämta fastighetsreferenser.

Operation	Beskrivning
`GET /referens/inteckning/{id}`	Hämta fastighetsreferenser som belastas av en inteckning.

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 inskrivning med id för inskrivningsfastighet. Delar av inskrivningen kan hämtas genom includeData-parametern.

Exempel

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

Requestparametrar

Namn	Beskrivning	Typ	Datatyp	Obligatorisk
id	Inskrivningens objektidentitet.	path	string (uuid)	ja
includeData	Vad i inskrivningen som ska hämtas. Flera delmängder kan anges som en kommaseparerad lista. Endast ett av `agareAktuella` och `agareAlla` kan väljas. `forvarv` måste kombineras med något av `agareAktuella` och `agareAlla`. `total` kan inte kombineras med övriga delmängder. Som default hämtas ingenting. Möjliga värden: `inskrivningsfastighet` - IRFastighet, område, pågåendeärende och gruppinformation. `agareAktuella` - fastighetens gällande ägare. `agareAlla` - fastighetens gällande och tidigare ägare. `forvarv` - ägarförändringsinformation. `avtalsrattighet` - avtalsrättigheter. `inteckning` - inteckningar. `anteckning` - anteckningar. `tomtrattsupplatelse` - tomträttsupplåtelser. `total` - allt.	query	string[] (x ∈ { "inskrivningsfastighet", "agareAktuella", "agareAlla", "forvarv", "avtalsrattighet", "inteckning", "anteckning", "tomtrattsupplatelse", "total" })	nej
excludePersonid	Endast för internt bruk. Anger om personidn ska med i svaret. Alltid `true` om parametern `marknadsforing` är `true`. Default: `false`	query	boolean	nej
marknadsforing	Endast för internt bruk. Anger om informationshämtningen görs i marknadsföringssyfte. Om `true` sätts parametern `excludePersonid` till `true`. Default: `false`	query	boolean	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 InskrivningResponse i form av en GeoJSON eller GML FeatureCollection med inskrivningar, beroende på vilket format som efterfrågades.

POST /

Beskrivning

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

Exempel

/?includeData=total

Body, Content-Type: application/xml

<IdRequest
    xmlns="http://namespace.lantmateriet.se/distribution/produkter/inskrivning/v3">
  <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 inskrivningen som ska hämtas. Flera delmängder kan anges som en kommaseparerad lista. Endast ett av `agareAktuella` och `agareAlla` kan väljas. `forvarv` måste kombineras med något av `agareAktuella` och `agareAlla`. `total` kan inte kombineras med övriga delmängder. Som default hämtas ingenting. Möjliga värden: `inskrivningsfastighet` - IRFastighet, område, pågåendeärende och gruppinformation. `agareAktuella` - fastighetens gällande ägare. `agareAlla` - fastighetens gällande och tidigare ägare. `forvarv` - ägarförändringsinformation. `avtalsrattighet` - avtalsrättigheter. `inteckning` - inteckningar. `anteckning` - anteckningar. `tomtrattsupplatelse` - tomträttsupplåtelser. `total` - allt.	query	string[] (x ∈ { "inskrivningsfastighet", "agareAktuella", "agareAlla", "forvarv", "avtalsrattighet", "inteckning", "anteckning", "tomtrattsupplatelse", "total" })	nej
excludePersonid	Endast för internt bruk. Anger om personidn ska med i svaret. Alltid `true` om parametern `marknadsforing` är `true`. Default: `false`	query	boolean	nej
marknadsforing	Endast för internt bruk. Anger om informationshämtningen görs i marknadsföringssyfte. Om `true` sätts parametern `excludePersonid` till `true`. Default: `false`	query	boolean	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 InskrivningResponse i form av en GeoJSON eller GML FeatureCollection med inskrivningar, beroende på vilket format som efterfrågades.

GET /beror/{id}

Beskrivning

Hämta en inskrivning med fastighetens objektidentitet. Delar av inskrivningen kan hämtas genom includeData-parametern.

Exempel

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

Requestparametrar

Namn Beskrivning Typ Datatyp Obligatorisk

id Fastighetens id i form av ett UUID. path string (uuid) ja

includeData

Vad i inskrivningen som ska hämtas. Flera delmängder kan anges som en kommaseparerad lista. Endast ett av agareAktuella och agareAlla kan väljas. forvarv måste kombineras med något av agareAktuella och agareAlla. total kan inte kombineras med övriga delmängder. Som default hämtas ingenting. Möjliga värden:

inskrivningsfastighet - IRFastighet, område, pågåendeärende och gruppinformation.
agareAktuella - fastighetens gällande ägare.
agareAlla - fastighetens gällande och tidigare ägare.
forvarv - ägarförändringsinformation.
avtalsrattighet - avtalsrättigheter.
inteckning - inteckningar.
anteckning - anteckningar.
tomtrattsupplatelse - tomträttsupplåtelser.
total - allt.

query

string[] (x ∈ { "inskrivningsfastighet", "agareAktuella", "agareAlla", "forvarv", "avtalsrattighet", "inteckning", "anteckning", "tomtrattsupplatelse", "total" })

nej

Svar

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

POST /beror

Beskrivning

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

Exempel

/beror?includeData=inskrivningsfastighet,agandeAktuellt

Body, Content-Type: application/xml

<IdRequest
    xmlns="http://namespace.lantmateriet.se/distribution/produkter/inskrivning/v3">
  <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 inskrivningen som ska hämtas. Flera delmängder kan anges som en kommaseparerad lista. Endast ett av agareAktuella och agareAlla kan väljas. forvarv måste kombineras med något av agareAktuella och agareAlla. total kan inte kombineras med övriga delmängder. Som default hämtas ingenting. Möjliga värden:

inskrivningsfastighet - IRFastighet, område, pågåendeärende och gruppinformation.
agareAktuella - fastighetens gällande ägare.
agareAlla - fastighetens gällande och tidigare ägare.
forvarv - ägarförändringsinformation.
avtalsrattighet - avtalsrättigheter.
inteckning - inteckningar.
anteckning - anteckningar.
tomtrattsupplatelse - tomträttsupplåtelser.
total - allt.

query

string[] (x ∈ { "inskrivningsfastighet", "agareAktuella", "agareAlla", "forvarv", "avtalsrattighet", "inteckning", "anteckning", "tomtrattsupplatelse", "total" })

nej

Svar

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

GET /referens/inteckning/{id}

Beskrivning

Hitta fastigheter som belastas av en inteckning.

Exempel

/referens/inteckning/12345678-1234-1234-1234-123456789012

Requestparametrar

Namn	Beskrivning	Typ	Datatyp	Obligatorisk
id	Intecknings id i form av ett UUID.	path	string (uuid)	ja

Svar

Ett FastighetsreferensResponse i form av en JSON eller XML med fastighetsreferenser.

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

Properties

Namn	Beskrivning	Typ	Multiplicitet
id	Inskrivningens eller fastighetens objektidentitet.	string (uuid)	1..*

Exempel

XML

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

Svar

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

Felmeddelande

Sammanfattning

Inskrivning

Referens

Hälsokontroll

Operationer

GET /{id}

Beskrivning

Exempel

Requestparametrar

Svar

POST /

Beskrivning

Exempel

Requestparametrar

Svar

GET /beror/{id}

Beskrivning

Exempel

Requestparametrar

Svar

POST /beror

Beskrivning

Exempel

Requestparametrar

Svar

GET /referens/inteckning/{id}

Beskrivning

Exempel

Requestparametrar

Svar

GET /health

Datatyper

Frågor

IdRequest

Properties

Exempel

Svar

HealthResponse

Felmeddelande

Fault

Properties

Exempel

Versionshistorik, Inskrivning Direkt