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 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

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

Request Url: https://{server}/weave/services/api/v1/data/fetch/search?search=fib.fastighet.update&data=dd.fib.fastighet.search&includeKey=false&metadata=true&start=0&limit=10&rowFormat=array
Method: POST
Request Headers:
{
  "Accept": "application/json",
  "Content-Type": "application/x-www-form-urlencoded",
  "Authorization": "Bearer J.W.T"
}
Request Body:
{
  "date_from": "2024-01-01T00:00:00",
  "date_to": "2024-01-31T23:59:59"
}

Svar

{
  "total": 406,
  "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": [
    [
      "0afa5219-6331-4e76-9d19-452755098611",
      "LEVANDE",
      2,
      "2024-01-17T20:41:16",
      "2024-01-17",
      "FASTIGHET",
      "21",
      "80",
      "GAMMELSÄLL",
      "4",
      2,
      false,
      false,
      false,
      false,
      false,
      1193,
      0,
      1193,
      null,
      1
    ]
  ]
}

Snabbsök

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

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

Request Url: https://{server}/weave/services/api/v1/index/search?entity=fib.fastighet&query=norr&crs=EPSG:4326&limit=1
Method: GET
Request Headers:
{
  "Authorization": "Bearer J.W.T"
}

Svar

Hämta attribut från ID

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

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

Exempel

Svar

Hämta geografisk information

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

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

iKartan användarhanledning

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