Eftersom detta API är dynamiskt och innehållet anpassas till konfiguration är vissa delar inte applicerbara i alla lägen. Exempelvis ID för olika komponenter (datadefinitioner, attributsök, dataslag, etc.) och attribut kan variera efter installation och anpassning

Den här dokumentet visar översiktlig åtkomst för grundläggande åtkomst till fastighetsinformation via API.

Autentisering

I de flesta fall krävs en API-nyckel i form av en JSON Web Token (JWT) som genereras och ges ut av en administratör. JWT-nyckeln är oftas låst till en specifik IP-adress och med begränsad giltighetstid.

Attributsök

Parametrar för fastighet: search=fib.fastighet.update, data=dd.fib.fastighet.search

Parametrar för fastighetåtgärd: search=fib.fastighet.fastighetsatgard.update, data=dd.fib.fastighet.fastighetsatgard.search

Parametrar för belägenhetsadress: search=fib.adress.update, data=dd.fib.adress.search

Beskrivning

Hämta en eller flera dataenheter med attributsök och få svar med resultat från datadefinition.

Sökväg

/services/api/v1/data/fetch/search

Request-parametrar

Namn	Beskrivning	Default	Obligatorisk
search	Referens till attributsök		Ja
data	Referens till datadefinition för resultat		Ja
includeKey	Inkludera nyckel i svar	Ja	Nej
metadata	Inkludera metadata för datadefinition	Nej	Nej
rowFormat	Radformat. object eller array	object	Nej
start	Första raden vid paginering		Nej
limit	Begränsa antal rader vid paginering		Nej

Anrop skickas med Headers: Accept: application/jsonoch Content-Type: application/x-www-form-urlencoded

Exempel

curl -X POST \
 "https://<SERVER>/weave/services/api/v1/data/fetch/search?search=fib.fastighet.update&data=dd.fib.fastighet&includeKey=false&metadata=true&rowFormat=array&limit=1" \
 "Authorization: Bearer <TOKEN>" \
 -H "Content-Type: application/x-www-form-urlencoded" \
 -H "Accept: application/json" \
 -H "Authorization: Bearer <TOKEN>" \
 -d "date_from=2024-05-22T00:00:00&date_to=2024-05-23T23:59:59"

Svar

{
  "total": 2,
  "metadata": [
    {
      "id": "objektidentitet",
      "label": "Objektidentitet",
      "type": "string",
      "key": true
    },
    {
      "id": "status",
      "label": "Status",
      "type": "string"
    },
    {
      "id": "objektversion",
      "label": "Objektversion",
      "type": "int"
    },
    {
      "id": "versiongiltigfran",
      "label": "Versiongiltigfran",
      "type": "datetime"
    },
    {
      "id": "senasteandringallmannadelen",
      "label": "Senasteandringallmannadelen",
      "type": "date"
    },
    {
      "id": "typ",
      "label": "Typ",
      "type": "string"
    },
    {
      "id": "lanskod",
      "label": "Lanskod",
      "type": "string"
    },
    {
      "id": "kommunkod",
      "label": "Kommunkod",
      "type": "string"
    },
    {
      "id": "trakt",
      "label": "Trakt",
      "type": "string"
    },
    {
      "id": "block",
      "label": "Block",
      "type": "string"
    },
    {
      "id": "enhet",
      "label": "Enhet",
      "type": "int"
    },
    {
      "id": "_3dutrymme",
      "label": " 3dutrymme",
      "type": "boolean"
    },
    {
      "id": "agarlagenhetsfastighet",
      "label": "Agarlagenhetsfastighet",
      "type": "boolean"
    },
    {
      "id": "arealuppgiftosaker",
      "label": "Arealuppgiftosaker",
      "type": "boolean"
    },
    {
      "id": "urholkasav3dutrymme",
      "label": "Urholkasav3dutrymme",
      "type": "boolean"
    },
    {
      "id": "urholkasavagarlagenhetsfastighet",
      "label": "Urholkasavagarlagenhetsfastighet",
      "type": "boolean"
    },
    {
      "id": "totallandareal",
      "label": "Totallandareal",
      "type": "float"
    },
    {
      "id": "totalvattenareal",
      "label": "Totalvattenareal",
      "type": "float"
    },
    {
      "id": "totalareal",
      "label": "Totalareal",
      "type": "float"
    },
    {
      "id": "vaningsplan",
      "label": "Vaningsplan",
      "type": "string"
    },
    {
      "id": "omraden_antal",
      "label": "Omraden Antal",
      "type": "int"
    }
  ],
  "results": [
    [
      "909a6a7c-ceb0-90ec-e040-ed8f66444c3f",
      "LEVANDE",
      2,
      "2024-05-22T18:34:22",
      "2024-05-22",
      "FASTIGHET",
      "21",
      "80",
      "FINNBÖLE",
      "5",
      8,
      false,
      false,
      false,
      false,
      false,
      176598,
      0,
      176598,
      null,
      5
    ]
  ]
}

Snabbsök

Parametrar för fastighet: entity=fib.fastighet

Parametrar för belägenhetsadress: entity=fib.adress

Beskrivning

Sök dataenheter med sökord och få svar med förslag på träffar. Svaret innehåller ID för dataenhet, geografisk position samt benämning.

Sökväg

/services/api/v1/index/search

Request-parametrar

Namn	Beskrivning	Default	Obligatorisk
entity	Referens till dataslag		Ja
query	Sökord		Ja
crs	Referenssystem för koordinater	Samma som lagrad i datakälla	Nej
start	Första raden vid paginering	0	Nej
limit	Begränsa antal rader vid paginering	10	Nej
greedy		true	Nej
type	Söktyp exact - använd sökterm wildcard - Lägger till * i slutet av frågan fuzzy - lägger till ~ i slutet av frågan	wildcard	Nej

Exempel

curl -X GET \
 "https://test.ikartan.se/weave/services/api/v1/index/search?entity=fib.adress&query=myggda%203&crs=EPSG%3A3006&start=0&limit=1" \
 -H "Content-Type: application/x-www-form-urlencoded" \
 -H "Accept: application/json" \
 -H "Authorization: Bearer <TOKEN>"

Svar

{
  "total": 8,
  "results": [
    {
      "display2": "80264 Gävle",
      "display1": "Myggdansvägen 3A",
      "centroid": [
        616485.463,
        6726786.503
      ],
      "index": 1,
      "bounds": [
        616485.463,
        6726786.503,
        616485.463,
        6726786.503
      ],
      "entityid": "00d6d015-b9ec-4fd5-aaad-5618d0caac01",
      "entity": "fib.adress",
      "group": "FIB",
      "id": "fib.adress_00d6d015-b9ec-4fd5-aaad-5618d0caac01_1"
    }
  ]
}

Hämta attribut från ID

Parametrar för fastighet: data=dd.fib.fastighet

Parametrar för belägenhetsadress: data=dd.fib.adress

Beskrivning

Hämta en eller flera dataenheter med ID och få svar med resultat från datadefinition.

Sökväg

services/api/v1/data/fetch/ids

Request-parametrar

Namn	Beskrivning	Default	Obligatorisk
data	Referens till datadefinition för resultat		Ja
includeKey	Inkludera nyckel i svar	Ja	Nej
metadata	Inkludera metadata för datadefinition	Nej	Nej
rowFormat	Radformat. object eller array	object	Nej
start	Första raden vid paginering		Nej
limit	Begränsa antal rader vid paginering		Nej

Anrop skickas med Headers: Accept: application/jsonoch Content-Type: application/x-www-form-urlencoded

Exempel

curl -X POST \
  "https://<SERVER>/weave/services/api/v1/data/fetch/ids?data=d.fib.adress&includeKey=false&metadata=false&limit=1&rowFormat=object" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer <TOKEN>" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  -d "ids=4c88d264-e0f6-4586-bcb7-8a67a8aad1f5&ids=c17f6b6c-5354-4356-b642-c9f5d2aa49b0"

Svar

{
  "total": 2,
  "results": [
    {
      "kommundel": "Gävle",
      "insamlingslage": "INGÅNG",
      "versiongiltigfran": "2024-02-15T19:01:12",
      "adressomrade": "Stålbogatan",
      "bokstavstillagg": null,
      "kommunkod": "2180",
      "adressplatstyp": "GATUADRESSPLATS",
      "registerenhet": "909a6a7d-05e4-90ec-e040-ed8f66444c3f",
      "objektstatus": "GÄLLANDE",
      "postnummer": 80646,
      "objektversion": 2,
      "objektidentitet": "4c88d264-e0f6-4586-bcb7-8a67a8aad1f5",
      "adressplatsnummer": "17",
      "kommunnamn": "Gävle",
      "postort": "Gävle"
    }
  ]
}

Hämta geografisk information

Parametrar för fastighet: entity=fib.fastighet, datadefinition=dd.fib.fastighet

Parametrar för belägenhetsadress: entity=fib.adress, datadefinition=dd.fib.adress

Beskrivning

Hämta en eller flera dataenheter som GeoJSON Feature Collection med ID. Svaret innehåller geografisk position samt attribut från datadefinition.

Sökväg

services/api/v1/geometry/entities/feature

Request-parametrar

Body: Form-encode

Namn	Beskrivning	Default	Obligatorisk
datadefinition	Referens till datadefinition för resultat		Ja
entity	Referens till dataslag		Ja
ids	Lista med ID som efterfrågas. 1…n		Ja
crs	Referenssystem för koordinater	4326	Nej

Anrop skickas med Headers: Accept: application/jsonoch Content-Type: application/x-www-form-urlencoded

Exempel

curl  -X POST \
  "https://<SERVER>/weave/services/api/v1/geometry/entities/feature" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer <TOKEN>" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  -d "entity=fib.adress" \
  -d "datadefinition=d.fib.adress" \
  -d "ids=4c88d264-e0f6-4586-bcb7-8a67a8aad1f5" \
  -d "ids=c17f6b6c-5354-4356-b642-c9f5d2aa49b0" \
  -d "crs=EPSG:3006"

Attributsök

Attributsök är en sökdefinition för att söka ut eller filtrera en datatyp baserat på attribut eller egenskaper. Resultatet av en attributsökning är en lista med referenser/id som exempelvis användas för att hämta attributinformation (se Datadefinition nedan).

Mer information om attributsök finns här

Fastighet

fib.fastighet.update

Sök fastighet som förändrats inom datumspann.

Parametrar

Namn

Beskrivning

Obligatorisk

municipality_code

Visa enbart poster som tillhör en kommun. Anges som kommunkod, exempelvis 2180 för Gävle

Nej

date_from

Tidigast Datum/tid för förändring.

Skrivs i formatet yyyy-MM-dd'T'HH:mm:ss

Nej

date_to

Senast Datum/tid för förändring.

Skrivs i formatet yyyy-MM-dd'T'HH:mm:ss

Nej

Fastighetsåtgärd

fib.fastighet.fastighetsatgard.update

Sök efter fastighetsåtgärder som förändrats inom datumspann och/eller relativt en registerenhet.

Parametrar

Namn

Beskrivning

Obligatorisk

property_reference

UUID-referens till registerenhet. Begränsa urvalet till fastighetåtgärder för en specifik registerenhet.

Nej

date_from

Tidigast Datum/tid för förändring.

Skrivs i formatet yyyy-MM-dd'T'HH:mm:ss

Nej

date_to

Senast Datum/tid för förändring.

Skrivs i formatet yyyy-MM-dd'T'HH:mm:ss

Nej

Adressplats

fib.address.update

Sök efter adressplatser som förändrats inom datumspann

Parametrar

Namn	Beskrivning	Obligatorisk
registerenhet	Hämta adressplatser kopplade till en specifik registerenhet	Nej
municipality_code	Visa enbart poster som tillhör en kommun. Anges som kommunkod, exempelvis 2180 för Gävle	Nej
date_from	Tidigast Datum/tid för förändring. Skrivs i formatet `yyyy-MM-dd'T'HH:mm:ss`	Nej
date_to	Senast Datum/tid för förändring. Skrivs i formatet `yyyy-MM-dd'T'HH:mm:ss`	Nej

Datadefinition

En datadefinition är en modell för tabulär data. Den beskrivs med en eller flera attribut och typ samt ett nyckelattribut som identifierar raden. Dataresultat från en datadefinition sker genom referens med ID (referens till nyckelattribut) eller understött av exempelvis Attributsök.

Mer information om datadefinitioner finns här.

Fastighet

dd.fib.fastighet

Grundläggande attribut för fastigheter

Fastighetsåtgärd

dd.fib.fastighet.fastighetsatgard

Attribut för fastighetsåtgärder

Ursprung fastighet

dd.fib.fastighet.ursprung

Attribut för en med referenser till ursprungsfastighet

Adressplats

dd.fib.address

Attribut för adressplatser

API-dokumentation

Autentisering

Attributsök

Beskrivning

Sökväg

Request-parametrar

Exempel

Svar

Snabbsök

Beskrivning

Sökväg

Request-parametrar

Exempel

Svar

Hämta attribut från ID

Beskrivning

Sökväg

Request-parametrar

Exempel

Svar

Hämta geografisk information

Beskrivning

Sökväg

Request-parametrar

Body: Form-encode

Exempel

Attributsök

Fastighet

Parametrar

Fastighetsåtgärd

Parametrar

Adressplats

Parametrar

Datadefinition

Fastighet

Fastighetsåtgärd

Ursprung fastighet

Adressplats