Spring til indhold

Grundfast

Hent mange områder

Mange områder fra samme tema i ét kald — 50 på Pro, flere på Scale og Enterprise — med fejl pr. kode i stedet for én samlet fejl.

POST/v1/dagi:batch

Send ét tema og en liste af koder. Dubletter fjernes, og hver kode slås op præcis som i /v1/dagi/:tema/:kode — navn altid, geometri best-effort.

En ukendt kode fælder ikke kaldet: den havner i errors med sin egen status (typisk 404), mens de øvrige kommer i results. Kaldet svarer 200, så længe selve forespørgslen er gyldig. Er mindst én geometri cachet og ældre, sættes headeren X-Grundfast-Stale: true, og det pågældende resultat har stale: true.

Godkendelse · API-nøgle

Send din nøgle som Authorization: Bearer gf_live_… — eller gf_test_… for gratis sandbox-kald. Se Godkendelse og nøgler.

Kræver Pro-planen

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

Afregning

Én enhed pr. unik kode; koder, der ender i errors, afregnes ikke.

Eksempel

curl -X POST "https://api.grundfast.dk/v1/dagi:batch" \
  -H "Authorization: Bearer $GRUNDFAST_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"tema":"kommune","kode":["0751","0101","9999"]}'
Svar · eksempel, forkortet200
{
  "tema": "kommune",
  "results": [
    {
      "kode": "0101",
      "omraade": {
        "tema": "kommune",
        "kode": "0101",
        "navn": "København",
        "regionskode": "1084",
        "geometri": {
          "type": "MultiPolygon",
          "coordinates": [
            [
              [
                [12.5448629, 55.6408618],
                [12.5448636, 55.6408517],
                [12.5448707, 55.6408424],
                [12.5448834, 55.6408353],
                [12.5449811, 55.6407917],
                [12.5449935, 55.6407865],
                [12.5450088, 55.6407853],
                [12.5450234, 55.6407882],
                [12.5450338, 55.6407947],
                [12.5454477, 55.6411628],
                [12.5455463, 55.6412655],
                [12.5455859, 55.6412862],
                [12.5456204, 55.6413096],
                [12.5456492, 55.6413355],
                [12.5456717, 55.6413632],
                [12.5456877, 55.6413923],
                [12.5456966, 55.6414223],
                [12.5458049, 55.6415354],
                [12.5458082, 55.641549],
                [12.5458058, 55.6415627],
                [12.5457976, 55.6415757],
                [12.5457842, 55.6415872],
                [12.5457325, 55.6416066],
                [12.5457105, 55.6416133],
                [12.5456857, 55.6416145],
                [12.5456619, 55.6416102],
                [12.5456431, 55.641601],
                [12.545273, 55.6412617],
                [12.5452693, 55.6412575],
                [12.5452657, 55.6412534],
                [12.5452462, 55.6412186],
                [12.5448689, 55.6408713],
                [12.5448629, 55.6408618]
              ]
            ]
          ],
          "epsg25832_rings": [
            [
              [723079.5, 6171809.45],
              [723079.82, 6171810.53],
              [723101.58, 6171850.37],
              [723102.61, 6171854.3],
              [723102.81, 6171854.77],
              [723103.02, 6171855.24],
              [723124.37, 6171894.17],
              [723125.5, 6171895.25],
              [723126.97, 6171895.81],
              [723128.54, 6171895.75],
              [723129.96, 6171895.08],
              [723133.32, 6171893.09],
              [723134.23, 6171891.85],
              [723134.82, 6171890.43],
              [723135.05, 6171888.92],
              [723134.92, 6171887.39],
              [723128.75, 6171874.47],
              [723128.36, 6171871.1],
              [723127.52, 6171867.81],
              [723126.26, 6171864.66],
              [723124.6, 6171861.69],
              [723122.56, 6171858.98],
              [723120.19, 6171856.55],
              [723114.57, 6171844.81],
              [723090.63, 6171802.54],
              [723090.01, 6171801.78],
              [723089.11, 6171801.41],
              [723088.14, 6171801.5],
              [723087.33, 6171802.04],
              [723080.94, 6171806.57],
              [723080.1, 6171807.32],
              [723079.6, 6171808.33],
              [723079.5, 6171809.45]
            ]
          ]
        },
        "meta": {
          "kilde": "Datafordeler DAGI via Grundfast",
          "grundfast_version": "0.1.0",
          "geometri_status": "live"
        }
      },
      "stale": false
    }
  ],
  "errors": [
    {
      "kode": "9999",
      "error": "kommune '9999' not found",
      "status": 404
    }
  ],
  "requested": 3,
  "succeeded": 2,
  "failed": 1
}

Forkortet: lange lister og geometrier er skåret ned — de viste værdier er uændrede.

Request-body

JSON med Content-Type: application/json.

temastringbodypåkrævet
Den inddeling, alle koderne hører til.Værdier:regionkommunesognretskredspolitikredsopstillingskreds
kodestring[]bodypåkrævet
DAGI-koder som strenge. Dubletter tælles én gang. Antallet pr. kald følger planen: 50 på Pro, 100 på Scale og 150 på Enterprise. En længere liste afvises med 402, der nævner den plan, der tager den — eller send listen som et job.

Felter i svaret

results[].omraadeDagiOmraade
Samme form som svaret fra /v1/dagi/:tema/:kode.
results[].staleboolean
Sand, når geometrien kom fra en ældre cachet kopi.
errors[]{ kode, error, status }
Koder, der ikke kunne slås op, med den status et enkeltopslag ville have givet.
requested / succeeded / failedinteger
Antal unikke koder, antal besvarede og antal fejlede.

Statuskoder

StatusBetydning
200Svaret er leveret.
400Body’en er ikke { tema, kode: string[] }, listen er tom eller længere, end nogen plan tager pr. kald, eller tema er ukendt.
401Nøglen mangler eller er ugyldig.
402Planen er under Pro, eller listen er længere end din plans loft pr. kald. Svaret nævner den plan, der tager den.
429Burst-grænsen eller månedskvoten er nået. Se Retry-After.

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/dagi:batch

Bruges ofte sammen med

Læs mere om DAGI, og hvad data kan bruges til, på produktsiden.