Gränssnittsdefinition
Åtkomstpunkt
Verifiering: https://api-ver.lantmateriet.se/distribution/produkter/uppslag/organisation/v2
Produktion: https://api.lantmateriet.se/distribution/produkter/uppslag/organisation/v2
Schema
XML: http://namespace.lantmateriet.se/distribution/produkter/uppslag/organisation/v2/uppslag-organisation-2.0.0.xsd
JSON: http://namespace.lantmateriet.se/distribution/produkter/uppslag/organisation/v2/uppslag-organisation-2.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
Referens
Hitta referenser till registerenheter och taxeringsenheter.
| Operation | Beskrivning |
|---|---|
GET /{id} | Hitta ägande med ett organisationsnummer. |
POST / | Hitta ägande med ett eller flera organisationsnummer. |
Operationer
GET /{id}
Beskrivning
Hitta inskrivet och taxerat ägande med organisationsnummer.
Exempel
/123456-1234
Requestparametrar
| Namn | Beskrivning | Typ | Datatyp | Obligatorisk |
|---|---|---|---|---|
| id | Organisationens organisationsnummer. | path | string | ja |
Svar
Ett InnehavResponse i form av en JSON-array eller ett XML-objekt, beroende på vilket format som efterfrågades.
POST /
Beskrivning
Hitta en eller flera organisationers inskrivna och taxerade ägande med organisationsnummer. 250 id:n kan skickas in i samma fråga.
Exempel
/
<IdRequest
xmlns="http://namespace.lantmateriet.se/distribution/produkter/uppslag/organisation/v2">
<id>123456-1234</id>
<id>654321-4321</id>
</IdRequest>["123456-1234", "654321-4321"]Requestparametrar
Body: IdRequest - ett objekt innehållande en lista med organisationsnummer.
Svar
Ett InnehavResponse i form av en JSON-array eller ett XML-objekt, beroende på vilket format som efterfrågades.
Datatyper
Frågor
IdRequest
Hitta ägande med organisationsnummer. 250 idn kan anges i en fråga.
Properties
| Namn | Beskrivning | Typ | Multiplicitet |
|---|---|---|---|
| id | Organisationsnummer. | string | 1..* |
Exempel
<IdRequest
xmlns="http://namespace.lantmateriet.se/distribution/produkter/uppslag/organisation/v2">
<id>123456-1234</id>
<id>654321-4321</id>
</IdRequest>["123456-1234", "654321-4321"]Svar
InnehavResponse
Behållare för sökningens resultat - ingen, en eller flera sökträffar av typen Innehav.
Properties
| Namn | Beskrivning | Typ | Multiplicitet |
|---|---|---|---|
| Innehav | Behållare för en organisations ägande | Innehav | 0..* |
Exempel
<InnehavResponse xmlns="http://namespace.lantmateriet.se/distribution/produkter/uppslag/organisation/v2">
<Innehav>
...
</Innehav>
<Innehav>
...
</Innehav>
</InnehavResponse>[
{
"id" : "123456-1234",
...
},
{
"id" : "654321-4321",
...
}
]Innehav
Properties
| Namn | Typ | Multiplicitet |
|---|---|---|
| id | string (uuid) | 1 |
| LagfarenAgare | InskrivetAgande | 0..* |
| Tomtrattsinnehavare | InskrivetAgande | 0..* |
| TidigareLagfarenAgare | InskrivetAgande | 0..* |
| TidigareTomtrattsinnehavare | InskrivetAgande | 0..* |
| TaxeradAgare | Taxeringsenhetsreferens | 0..* |
Exempel
<Innehav>
<id>123456-1234</id>
<LagfarenAgare>
...
</LagfarenAgare>
<LagfarenAgare>
...
</LagfarenAgare>
<Tomtrattsinnehavare>
...
</Tomtrattsinnehavare>
<Tomtrattsinnehavare>
...
</Tomtrattsinnehavare>
<TidigareLagfarenAgare>
...
</TidigareLagfarenAgare>
<TidigareLagfarenAgare>
...
</TidigareLagfarenAgare>
<TidigareTomtrattsinnehavare>
...
</TidigareTomtrattsinnehavare>
<TidigareTomtrattsinnehavare>
...
</TidigareTomtrattsinnehavare>
<TaxeradAgare>
...
</TaxeradAgare>
<TaxeradAgare>
...
</TaxeradAgare>
</Innehav>{
"id": "123456-1234",
"lagfarenAgare": [
...
],
"tomtrattsinnehavare": [
...
],
"tidigareLagfarenAgare": [
...
],
"tidigareTomtrattsinnehavare": [
...
],
"taxeradAgare": [
...
]
}InskrivetAgande
Properties
| Namn | Typ | Multiplicitet |
|---|---|---|
| Fastighetsreferens | Fastighetsreferens | 1 |
| beslut | string ( x ∈ { "Avslag", "Avvisad", "Beviljad", "Okänd", "Uppskov", "Vilande" } ) | 1 |
Exempel
<LagfarenAgare>
<Fastighetsreferens>
...
</Fastighetsreferens>
<beslut>Beviljad</beslut>
</LagfarenAgare>{
"fastighetsreferens": {
...
},
"beslut": "Avvisad"
}Fastighetsreferens
Properties
| Namn | Typ | Multiplicitet |
|---|---|---|
| objektidentitet | string (uuid) | 1 |
| beteckning | string | 1 |
| status | string ( x ∈ { "avregistrerad", "levande" } ) | 1 |
Exempel
<Fastighetsreferens>
<objektidentitet>12345678-1234-cafe-1234-123456789abc</objektidentitet>
<beteckning>OMR TRAKT 3:3</beteckning>
<status>levande</status>
</Fastighetsreferens>{
"objektidentitet": "12345678-1234-cafe-1234-123456789abc",
"beteckning": "OMR TRAKT 3:3",
"status": "avregistrerad"
}Taxeringsenhetsreferens
Properties
| Namn | Typ | Multiplicitet |
|---|---|---|
| id | string | 1 |
| typ | string (x ∈ { "Lantbruksenhet", "Småhusenhet", "Hyreshusenhet", "Industrienhet", "Ägarlägenhet", "Täkt", "Elproduktionsenhet", "Specialenhet", "Okänd" } ) | 1 |
Exempel
<TaxeradAgare>
<id>123456-7</id>
<typ>Industrienhet</typ>
</TaxeradAgare>{
"id" : "123456-7",
"typ" : "Täkt"
}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
<Fault
xmlns="http://namespace.lantmateriet.se/distribution/produkter/fault/v1">
<code>400</code>
<reason>Bad Request</reason>
<errors>Too many IDs! Max is 250 - sent 302</errors>
</Fault>{
"code": 400,
"reason": "Bad Request",
"errors": [
"Too many IDs! Max is 250 - sent 302"
]
}