Guidelines
Subsections#sub
General Request structure
All URIs and their underlying operations are resource based.
The structure of the URIs is as follows:
product/version/area/sub-area(s)/resHTTP verbs GET
GET will read data. Data can be a list or single object of a resource.
- GET causes a 404 if the resource or endpoint could not be found
- GET causeStatus CodesHttp codes can be separated in 4 simple groups:
- codes for successful calls,
- calls redirected to new or moved URI,
- client and
- server sideResult codes and messagesError codes are reserved up to 10.000, ensuring a dedicated range and reserving space for future codes. The range starting at 10,001 is reserved for TERP v5.
VAuthentication and AuthorizationAll endpoints for this area can only be accessed if the client of the API is authenticated. A client is authenticated via the ADITUS identity provider (IdP) wit