Hoppa till huvudsakligt innehåll

Teknisk beskrivning

Gränssnittsdefinition

Åtkomstpunkt

Verifiering:  https://api-ver.lantmateriet.se/distribution/produkter/taxering/v3

Produktion:  https://api.lantmateriet.se/distribution/produkter/taxering/v3

Schema

XML:  http://namespace.lantmateriet.se/distribution/produkter/taxering/v3/taxering-3.0.2.xsd

JSON:  https://namespace.lantmateriet.se/distribution/produkter/taxering/v3/taxering-3.0.2.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

Taxeringsenhet

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

Operation

Beskrivning

GET /{id}
Hämta en taxeringsenhet med id.
POST /Hämta en eller flera taxeringsenheter med id.

Referens

Hämta referenser till taxeringsenheter. 

Operation

Beskrivning

GET /referens/beror/{id}

Hitta taxeringsenheter som berör en Registerenhet eller Gemensamhetsanläggning med id.

Operationer

GET /{id}

Beskrivning

Hämta en taxeringsenhet med taxeringsenhetsnummer. Delar av taxeringsenheten kan hämtas genom includeData-parametern. Taxering för föregående kalenderår kan hämtas genom parametern AllaVersioner.

Exempel

/123456-7?includeData=total

/100008-3?allaVersioner=true

Requestparametrar

Namn

Beskrivning

Typ

Datatyp

Obligatorisk

idTaxeringsenhetsnummer.path

string

Format: [0-9]{6}-[0-9]

Exempel: 123456-7

ja
includeData

Vad i taxeringsenheten som ska hämtas. Flera delmängder kan anges som en kommaseparerad lista. Kan ej kombineras med allaVersioner. Som default hämtas ingen delmängd.  Möjliga värden:

  • basinformation - hämtar taxeringsenhetsattribut.
  • beror - hämtar TaxeradRegisterenhet och TaxeradGemensamhetsanlaggning.
  • agare - hämtar TaxeradAgare.
  • varderingsenhet - hämtar värderingsenheter.
  • total - hämtar allt.
querystring[] (x  { "basinformation", "beror", "agare", "varderingsenhet", "total" })nej
allaVersionerKan användas för att hämta alla tillgängliga taxeringar för taxeringsenheten. Default: false. Kan ej kombineras med includeData. Delmängderna basinformation, beror och varderingsenhet hämtas när allaVersioner = true.querybooleannej

Svar

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



POST /

Beskrivning

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

Exempel

/?includeData=basinformation,beror

Body, Content-Type: application/xml
<IdRequest
      xmlns="http://namespace.lantmateriet.se/distribution/produkter/taxering/v3">
  <taxeringsenhetsnummer>123456-7</taxeringsenhetsnummer>
  <taxeringsenhetsnummer>100008-3</taxeringsenhetsnummer>
</IdRequest>
Body, Content-Type: application/json
{
    "taxeringsenhetsnummer": ["123456-7", "100008-3"]
}


Requestparametrar

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

Namn

Beskrivning

Typ

Datatyp

Obligatorisk

includeData

Vad i taxeringsenheten som ska hämtas. Flera delmängder kan anges som en kommaseparerad lista. Kan ej kombineras med allaVersioner. Som default hämtas ingen delmängd. Möjliga värden:

  • basinformation - hämtar taxeringsenhetsattribut. 
  • beror - hämtar TaxeradRegisterenhet och TaxeradGemensamhetsanlaggning.
  • agare - hämtar TaxeradAgare.
  • varderingsenhet - hämtar värderingsenheter.
  • total - hämtar allt.
querystring[] (x  { "basinformation", "beror", "agare", "varderingsenhet", "total" })nej
allaVersionerKan användas för att hämta alla tillgängliga taxeringar för taxeringsenheten. Default: false. Kan ej kombineras med includeData. Delmängderna basinformation, beror och varderingsenhet hämtas när allaVersioner = true.querybooleannej

Svar

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



GET /referens/beror/{id}

Beskrivning

Hämta referenser till taxeringsenheter med en given registerenhet eller gemensamhetsanläggning.

Exempel

/referens/beror/12345678-1234-1234-1234-1234567489012

/referens/beror/12345678-1234-1234-1234-1234567489012?allaVersioner=true

Requestparametrar

Namn

Beskrivning

Typ

Datatyp

Obligatorisk

idRegisterenhetens eller Gemensamhetsanläggningens objektidentitet.pathstring (uuid)ja
allaVersionerKan användas för att söka på alla tillgängliga taxeringar för taxeringsenheten. Default: false.querybooleannej

Svar

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

Datatyper

Frågor

IdRequest

Hämta taxeringsenhet med angiven identifierare. 250 id:n kan anges i en fråga.

Properties

Namn

Beskrivning

Typ

Multiplicitet

taxeringsenhetsnummerTaxeringsenhetens identitet.string1..*

Exempel

XML
<IdRequest
    xmlns="http://namespace.lantmateriet.se/distribution/produkter/taxering/v3">
  <taxeringsenhetsnummer>123456-7</taxeringsenhetsnummer>
  <taxeringsenhetsnummer>100008-3</taxeringsenhetsnummer>
</IdRequest>


JSON
{
    "taxeringsenhetsnummer": ["123456-7", "100008-3"]
}

Felmeddelande

Fault

Properties

Namn

Beskrivning

Typ

Multiplicitet

codeHTTP-felkod.integer1
reasonTextöversättning av felkod.string1
errorsMer detaljerad felbeskrivning.string0..*

Exempel

XML
Fault
    xmlns="http://namespace.lantmateriet.se/distribution/produkter/fault/v1">
  <code>400</code>
  <reason>Bad Request</reason>
  <errors>Illegal combination of 'includeData' and 'allaVersioner'</errors>
</Fault>
JSON
{
   "code": 400,
   "reason": "Bad Request",
   "errors": [
      "Illegal combination of 'includeData' and 'allaVersioner'"
   ]
}