Tilgang
Tilgang til API'et styres av en nøkkel som genereres ved bestilling

Et request autentiseres ved at en legger til nøkkelen som en url-parameter eller header ved navn 'key'.

Eksempel
'&key=d35a3753-aa65-479f-9f00-c5bea11892cf' i url eller header 'Key: d35a3753-aa65-479f-9f00-c5bea11892cf'


For å teste API'et kan du bruke nøkkelen apidemo





Url spørring
En kan bruke parametre i url til å begrense søk/gjøre utvalg i enkelte funksjoner

$top$top=nVelger de n øverste postene
$filter$filter=x eq|ne|gt|lt yVelger de postene der kolonne x lik|ulik|større enn|mindre enn y hhv. Kan kombinere med 'and|or'
$orderby$orderby=x desc|ascSorterer postene etter kolonne x synkende eller stigende hhv
$select$select=x,y,zVelger bare kolonnene x, y og z.

Eksempel
http://api.tidsbanken.net/Ansatte/Finn?$top=10&$filter=Ansattnummer lt 200&$orderby=Ansattnummer asc&$select=Ansattnummer,Fornavn,Etternavn

Filtrering på dato
Dersom du ønsker å filtrere på dato, må datoen først tolkes. Følgende URL-spørring vil hente ut alle timene for februar 2016:

http://api.tidsbanken.net/dev/Timelister/Finn?$filter=Dato gt datetime('2016-01-31') and Dato lt datetime('2016-03-01')





Format
Request/Response dataformat kan velges

En kan oppgi (ønsket) dataformat i request/response body ved å sette 'Content-type'/'Accept' header eller vha url-parameteren 'format'. Tilgjengelige formater er XML og JSON.

Eksempel:
'&format=json' i url eller 'Content-type: application/json'/'Accept: application/json' header.