Gränssnittsdefinition
Åtkomstpunkt
Verifiering: https://api-ver.lantmateriet.se/distribution/produkter/uppslag/organisation/v3
Produktion: https://api.lantmateriet.se/distribution/produkter/uppslag/organisation/v3
Schema
XML: http://namespace.lantmateriet.se/distribution/produkter/uppslag/organisation/v3/uppslag-organisation-3.0.0.xsd
JSON: http://namespace.lantmateriet.se/distribution/produkter/uppslag/organisation/v3/uppslag-organisation-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
Referens
Hitta referenser till registerenheter och taxeringsenheter.
| Operation | Beskrivning |
|---|---|
GET /{id} | Hitta ägande med ett organisationsnummer. |
POST / | Hitta ägande med ett eller flera organisationsnummer. |
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
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/v3">
<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.
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
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/v3">
<id>123456-1234</id>
<id>654321-4321</id>
</IdRequest>["123456-1234", "654321-4321"]HealthResponse
Anger status för tjänsten.
Properties
| Namn | Beskrivning | Typ | Multiplicitet |
|---|---|---|---|
| up | Anger status för tjänsten | boolean | 1 |
Exempel
{"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
<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"
]
}