API for HC-registeret
Her finner du informasjon om hvordan du kan ta i bruk API-er for HC-registeret (register over parkeringstillatelser for forflytningshemmede).
API-et kan benyttes av leverandører av parkeringssystemer til å melde inn nye parkeringstillatelser for forflytningshemmede eller endringer i disse. Det kan også brukes for å gjøre oppslag på gyldigheten til parkeringstillatelsene. Kommunene skal bruke dette for å legge inn, endre og hente ut sine bevis på parkeringstillatelser for forflytningshemmede.
Få tilgang
API-et er kostnadsfritt men krever autentisering. Dette datasettet er gjort tilgjengelig under norsk lisens for offentlige data (data.norge.no).
Autentisering
Autentisering foregår ved hjelp av «HTTP basic authentication». Brukernavn og passord fås ved å sende en forespørsel til . Brukeren man får er en såkalt «tjenestebruker» og må benyttes i alle API-kall mot HC-registeret.
Dokumentasjon
Se dokumentasjonen for API-et (Swagger) for å få en oversikt over de ulike endepunktene og beskrivelse av dataene.
Statuskoder
- GYLDIG
- IKKE_GYLDIG
- STJALET
- MISTET
- INNDRATT
- DOD
Brukerkoder
- F for fører
- P for passasjer
- U for ukjent (kan kun benyttes for bevis hvor gyldigFra er før 01.04.2017)
Bevistype
Hvis en respons inneholder et eller flere bevisobjekt skal det/de inneholde feltet «bevistype». Bevistypen forteller om beviset er et institusjonsbevis eller et personbevis.
- person
- institusjon