Hoppa till huvudsakligt innehåll

Teknisk beskrivning

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.

OperationBeskrivning
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 /healthHälsokontroll.

Operationer

GET /{id}

Beskrivning

Hitta inskrivet och taxerat ägande med organisationsnummer.

Exempel

/123456-1234

Requestparametrar

NamnBeskrivningTypDatatypObligatorisk
idOrganisationens organisationsnummer.pathstringja

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

/

Body, Content-Type: application/xml
<IdRequest
    xmlns="http://namespace.lantmateriet.se/distribution/produkter/uppslag/organisation/v3">
  <id>123456-1234</id>
  <id>654321-4321</id>
</IdRequest>
Body, Content-Type: application/json
["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
NamnBeskrivningTypMultiplicitet
idOrganisationsnummer.string1..*
Exempel
XML
<IdRequest
    xmlns="http://namespace.lantmateriet.se/distribution/produkter/uppslag/organisation/v3">
  <id>123456-1234</id>
  <id>654321-4321</id>
</IdRequest>
JSON
["123456-1234", "654321-4321"]



HealthResponse

Anger status för tjänsten.

Properties

NamnBeskrivningTypMultiplicitet
upAnger status för tjänstenboolean1

Exempel

JSON
{"up": true}



Felmeddelande

Fault

Properties
NamnBeskrivningTypMultiplicitet
codeHTTP-felkod.integer1
reasonTextöversättning av felkodstring1
errorsMer detaljerad felbeskrivningstring0..*
Exempel
XML
<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>
JSON
{
   "code": 400,
   "reason": "Bad Request",
   "errors": [
      "Too many IDs! Max is 250 - sent 302"
   ]
}

Tillbaka till Toppen av sidan