Spring til indhold

Grundfast

Overvåg ejendomme

Sæt op til 100 ejendomme på overvågningslisten, så du får en webhook, når BBR, vurdering, plandata eller jord ændrer sig.

POST/v1/overvaagning/ejendomme

Hver ejendom læses cirka én gang i døgnet fra BBR, ejendomsvurdering, plandata og områdeklassificering. Ændrer ét af registrene sig, sendes ejendom.aendret til de endpoints, der abonnerer på den — se Ejendomsovervågning.

Det første tjek er et udgangspunkt og sender ingen hændelse. BFE-numre, der allerede er på listen, røres ikke og returneres i allerede_overvaaget, så kaldet kan gentages uden skade.

Godkendelse · API-nøgle eller session

Virker med en Authorization: Bearer-nøgle eller med din login-session i dashboardet.

Kræver Pro-planen

På en lavere plan svarer endpointet 402. Se planerne.

Afregning

Ikke målt — overvågning følger med planen.

Eksempel

curl -X POST "https://api.grundfast.dk/v1/overvaagning/ejendomme" \
  -H "Authorization: Bearer $GRUNDFAST_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"bfe":[5651067,2425322],"note":"Portefølje Nord"}'
Svar · eksempel201
{
  "tilfoejet": 2,
  "allerede_overvaaget": [],
  "antal": 2,
  "maks": 250
}

Request-body

JSON med Content-Type: application/json.

bfeinteger[]bodypåkrævet
1-100 BFE-numre. Dubletter i listen tælles én gang.
notestringbodyvalgfri
Højst 200 tegn. Følger med på hver ejendom.aendret for de ejendomme, der tilføjes nu.

Felter i svaret

tilfoejetinteger
Hvor mange ejendomme der kom på listen med dette kald.
allerede_overvaagetinteger[]
De BFE-numre, der allerede var på listen, og som blev ladt urørt.
maksinteger
Planens loft for listen: 250 på Pro, 2.500 på Scale, 25.000 på Enterprise.

Statuskoder

StatusBetydning
201Oprettet — svaret beskriver det nye objekt.
400Kroppen er ugyldig: ingen BFE-numre, flere end 100, eller et ugyldigt tal.
401Hverken en gyldig nøgle eller en session.
402Planen er under Pro.
403Nøglen er en admin-nøgle, eller kontoen er suspenderet.
429Burst-grænsen pr. minut er nået.
409Listen ville komme over planens loft. Intet blev tilføjet.

Alle fejl har samme form. Byg logikken på type (fejlklassen) og vis message (dansk tekst med årsagen) til brugeren; hint kommer med, når vi kan se, hvad der skal rettes, og request_id er det, support skal bruge. Se Fejl og statuskoder for hver type, og hvad der kan prøves igen.

Fejlsvar · 404
{
  "error": "property not found",
  "type": "not_found",
  "code": "not_found",
  "message": "Ressourcen findes ikke.",
  "request_id": "6cbfa45a-a9ea-4140-9d42-ea752a70ff1f",
  "doc_url": "https://grundfast.dk/docs/fejl#not_found"
}

Prøv det

Live-kald fra siden

Kræver din nøgle

Nøglen bliver i denne fane og sendes kun til grundfast.dk. Kaldet tæller som et almindeligt kald — brug en gf_test_-nøgle for at prøve gratis. Opret en gratis nøgle

POST /v1/overvaagning/ejendomme

Bruges ofte sammen med