With every request, the X-Client-Token
header should be set. This is a custom header which is used to authenticate and authorize the client. The token is supplied by Poort80.
Any request with a missing X-Client-Token
header will be refused with a 403 Forbidden
status code.
The value of the standard Accept-Language
header is used to denote the requested language. When missing, "nl-NL" is used as the default.
Every resource in this documentation lists the Content-Type
s it may return. Any request should supply an Accept
header explicitly accepting one of these Content-Type
s, e.g. Accept: application/json
.
When an Accept
header is missing, or it has another value, 406 Not Acceptable
is returned.
POST
and PUT
requests with a body should have a Content-Type
that is accepted by the resource. Every POST
and PUT
resource in this documentation lists the Content-Type
s it accepts.
When an invalid Content-Type
is supplied, 415 Unsupported Media Type
is returned.
Boolean parameters can have the following values: 1
, true
, on
, yes
and enabled
are true, while 0
, false
, off
, no
and disabled
are false.
Datetime parameters can be in the formats 2009-02-15T00:00:00Z
, 2009-02-15T00:00:00
, 2009-02-15T00:00
or 2009-02-15
.
Also accepted are now
, yesterday
, today
, tomorrow
, monday
, tuesday
, wednesday
, thursday
, friday
, saturday
and sunday
.
Integer values are relative to today.
Examples:
The following are examples of caching headers which may be returned.
When the response is not cacheable:
Cache-Control: no-cache
When the response is cacheable:
Cache-Control: max-age=600, s-maxage=60
Expires: Thu, 24 Oct 2013 09:45:12 GMT
Vary: X-Client-Token,Accept-Language
X-Cache: miss, store
X-Cache: fresh
When the response is cacheable, but requires a session cache:
Cache-Control: max-age=600, s-maxage=60, private
Expires: Thu, 24 Oct 2013 09:45:12 GMT
Vary: X-Client-Token,Accept-Language
X-Cache: miss, store
X-Cache: fresh
The custom X-Request-Id
header denotes the id of the request. This id can be used to find a specific request in the logs. Example:X-Request-Id: c16e9175-284f-409b-86e8-4371fe157752
The custom X-Runtime
header denotes the duration of the request in the application. Example:X-Runtime: 42