API-dokumentasjon

Datafangst

Datafangst er et web-basert system for innsending, kontroll, redigering, og på sikt direkte registrering i NVDB. Systemet skal ta i mot - GPS-stedfestede data - for alle vegobjekter konstruert (eller endret) under et vegbyggingsprosjekt.

Entrepenører er pålagt å levere data fra vegprosjekter til Statens Vegvesen for registrering i NVDB. Data fra entrepenørene må kvalitetssikret og etterbehandles før de kan skrives til NVDB.

I Datafangst kan entrepenører laste opp SOSI-filer og få dem validert mot Datakatalogen, men den endelige registreringen av dataene til NVDB må gjøres av dataforvaltere hos Statens Vegvesen.

Release notes for datafangst oppdateres sporadisk her.

Tradisjonelt har data blitt levert på SOSI-format. I tillegg til å støtte opplasting av SOSI-filer til NVDB og FKB, har Datafangst også et API for å sende inn vegobjekter som geoJSON - dette APIet vil bli beskrevet i dette dokumentet.

Definisjoner

Før vi beskriver normal arbeidsflyt i Datafangst og APIet definerer vi noen termer som er brukt i NVDB-domenet. Engelsk oversettelse i parantes.

Endring av eksisterende vegobjekter i Datafangst

Per oktober 2017 er det støtte for å legge til nye objekter og sletting av eksisterende objekter i NVDB. Endringer på eksisterende NVDB objekter er planlagt støttet.

Roller og tilganger i Datafangst

Dataforvalter

Medlem på kontrakt

Oppretting av datafangst bruker kan gjøres fritt, men for eksterne å bruke datafangst trenger en å være invitert på en kontrakt. Dersom det er ønskelig å teste ut datafangst uten registrering kan dette gjøres med docker. Repository for datafangst og skrive-API finnes på https://hub.docker.com/u/nvdbapnevegdata/. Det er også mulig å få tildelt en test kontrakt, kontakt Terje Brasethvik for dette.

Dataflyt i Datafangst

Dataflyt i Datafangst

Innsending av data og eventuell registrering av «Ferdigvegsdata» følger en definert arbeidsflyt som nå vil bli beskrevet.

  1. Dataforvalter oppretter en kontrakt i webgrensesnittet.
  2. Dataforvalter konfigurerer kontrakten ved å definere dens objektliste og hvilke brukere som skal ha tilgang til den.
  3. Data lastes opp til kontrakten via nettleser eller API.
  4. Innsendte data blir validert synkront. Webgrensesnittet poller etter endringer og viser en spinner, ved bruk at API må en selv håndtere polling. De valideringer som blir gjort er blant andre attributt- og geometrivalidering mot Datakatalogen. Det blir også utført automatisk stedfesting på vegnettet, men denne informasjonen er bare tilgjengelig for dataforvaltere i webgrensesnittet,
  5. Gjennomgang av innsendte data, dataforvalter går gjennom data i webgrensesnittet. Entrepenører er ikke påkrevd å levere alle attributter som er påkrevd for registrering i NVDB, disse attributtene må Dataforvalter legge til etter innsending. Dataforvalter og andre prosjektdeltakere har mulighet til å legge til kommentarer på alle vegobjekter og vegobjekttyper, samt overordnede kommentarer for kontrakten. Dataforvalter har mulighet til å markere kommentarer som feil som innsender må ordne og deretter sende inn de aktuelle vegobjektene på nytt.
  6. Om den automatiske stedfestingen av objekter ikke er konklusiv må dataforvalter utføre denne manuelt. Objekter som hører sammen (f eks en skiltplate sitter alltid på et skiltpunkt) må kobles sammen av dataforvalter.
  7. Registrering til NVDB. Når alle data er godkjent og eventuelle valideringsfeil er rettet kan de sendes til NVDB. Denne opersjonen er ikke enda fullt støttet i Datafangst per oktober 2017, men den vil komme på neste release, som er godt på vei.

Datafangst API

Datafangst har et API som støtter geoJSON.

Forutsetninger

Operasjoner

Sti Verb Beskrivelse
/api/v1/contract/{contractId}/featurecollection POST POST en komplett «feature collection» til en kontrakt. Behandling og validering tar noe tid, derfor er denne operasjonen aynkron.
Responser:
202 Accepted + payload med URI for polling av status.
/api/v1/contract/{contractId}/featurecollection/{collectionId} GET Henter oppgitt feature collection Responser:
200 OK + payload med feature collection som geoJSON
/api/v1/contract/{contractId}/featurecollection/{featurecollectionid} PUT Erstatt den oppgitte feature collection Responser:
202 Accepted + payload med URI for polling av status.
/api/v1/contract/{contractId}/featurecollection/{featurecollectionid}/status GET Hent prosesseringsstatus for innsendt feature collection. Respons er json eller xml avhengig av klientens *Accept*-header. Responser:
200 OK + Payload
/api/v1/contract/{contractId}/featurecollection/{featurecollectionid}/feature POST POST et enkelt vegobjekt som geoJSON-feature.
Responser:
200 OK + Payload med valideringsstatus for vegobjektet.
/api/v1/contract/{contractId}/featurecollection/{featurecollectionid}/feature/{featureId} GET Hent et enkelt vegobjekt. Responser:
200 OK + Payload med vegobjekt som geoJSON feature
/api/v1/contract/{contractId}/featurecollection/{featurecollectionid}/feature/{featureId} PUT Erstatt oppgitt vegobjekt Responser:
200 OK + Payload med valideringsstatus for vegobjektet.
/api/v1/contract/{contractId}/featurecollection/{featurecollectionid}/feature/{featureId} DELETE Slett oppgitt vegobjekt Responser:
204 No content om sletting var vellykket
/api/v1/contract GET List opp alle kontrakter Responser:
200 OK + Payload med kontrakter med id og navn
/api/v1/contract/{contractId} GET Informasjon om kontrakten Responser:
200 OK + Payload med informasjon om kontrakten
/api/v1/contract/{contractId}/featurecollection GET FeatureCollections i kontrakt Responser:
200 OK + Payload med alle featurecollections i kontrakten

Alle operasjoner returnerer med 404 Not found dersom objektet med den oppgitte id ikke finnes. Om brukeren ikke er innlogget eller ikke har tilgang til kontraktet returnerer henholdsvis 401 Unauthorized og 403 Forbidden. Dersom innsendt payload ikke er velformet geoJSON vil 400 Bad request bli returnert.

Alle POST og PUT må ha Content-Type application/geo+json

Format

Datafangst-APIet bruker geoJSON som payload-format.

{
"type": "FeatureCollection",
  "features": [
    {
      "type": "Feature",
      "geometry": {
        "type": "Polygon",
        "coordinates": [
          [ [10.39241731, 63.43053048],
            [10.39495434, 63.43043698],
            [10.39579151, 63.42898665],
            [10.39272171, 63.42909269],
            [10.39241731, 63.43053048] ]
        ]
      },
      "properties": {
        "tag": "Forsterkningslag#1",
        "dataCatalogVersion": "2.06",
        "typeId": 227,
        "comment": "Usikker på måledatoen",
        "attributes": {
          "5543": "20160802"
         }
       }
    }
  ]
}

Geometriseksjonen i dette objektet er standard geoJSON. properties delen av objektet inneholder de attributtene som hører til vegobjektet.

Properties

Levering av featureCollection med FKB

For å sende inn FKB-objekter må request-parameter destination=FKB legges til, og for hver feature droppes dataCatalogVersion og typeName brukes for for hver feature i stedet for typeId.

POST /api/v1/contract/{contractId}/featurecollection?destination=FKB

{
"type": "FeatureCollection",
  "features": [
    {
      ... ,
      "properties": {
        "tag": "Stikkrenne#1",
        "typeName": "Stikkrenne",
        "comment": "Usikker på måledatoen",
        "attributes": {
          ...
         }
       }
    }
  ]
}

Postman collection for API-operasjoner