This API discloses the common entities in Richtlijnendatabase.nl oAuth2 This API uses standard oAuth2 for authentication, with the client credentials flow. Endpoints Endpoint URL Token https://auth.richtlijnendatabase.nl/token REST API https://api.richtlijnendatabase.nl GraphQL API https://api.richtlijnendatabase.nl/graphql The token endpoint should be used to obtain an access token which in turn can be used to authenticate to the API. Obtain access token: $ curl --request POST --url 'https://auth.richtlijnendatabase.nl/token' --data 'grant_type=client_credentials&client_id=YOUR_CLIENT_ID&client_secret=YOUR_CLIENT_SECRET' Access the API with obtained access token: $ curl --request GET --url https://api.richtlijnendatabase.nl/guidelines --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' Rate Limiting The API applies rate limiting and informs the client through the 'X-Ratelimit-Limit', 'X-Ratelimit-Remaining' and 'X-Ratelimit-Reset' response headers. It is advised to use a client that supports rate limiting (or avoid sending too many requests). Available formats The following formats are supported by the API: jsonld (application/ld+json) jsonhal (application/hal+json) jsonapi (application/vnd.api+json) json (application/json) jsonld (application/ld+json) graphql (application/graphql) You can differ between the desired formats by specifying the Content-Type (i.e. application/hal+json) in the Accept header of the request. GraphQL API GraphQL is supported, however it is limited when it comes to accessing properties of nested objects. For example: you can access some of the Module properties through GuidelineNavigations, but not the HTML and relationship fields (which is also the case through the regular REST API). You would have to access these through Module. GraphQL has its own endpoint. Primary entities The primary entities are Guideline, GuidelineNavigation and Module. A Guideline consists mostly of metadata and has multiple GuidelineNavigation objects related to it. A GuidelineNavigation consists of a title, order, parent and a reference to Guideline and Module. The collection of GuidelineNavigations make for the whole navigation tree of a Guideline. A Module consists of many fields and holds the actual textual content. Modules can be reused among different Guidelines (through GuidelineNavigation).
This endpoint is personalised based on the current JWT.
Version ID of the Module, in case a newer version of this Module is published its ID changes, but its groupId does not.
TODO: this item is currently not visible in website, but is in PDF (mistake?)
Module is a 'Table of Contents' (Startpage) type of module
Module type, 0 = standard module, 1 = Table of Contents module
The label of the ProductCategory this item belongs to
Retrieves GuidelineSearchResult resource.
Version ID of the Guideline, in case a newer version of this Guideline is published its ID changes, but its groupId does not.
If in development, a newer version is being worked on
On what date the Guideline was last checked
Organisations that initiated the Guideline
Retrieves the collection of User resources.
Retrieves the collection of Specialism resources.
Retrieves the collection of Module resources.
The collection of ModuleReference resources
Retrieves the collection of ModuleReference resources.
Retrieves the collection of ModuleFile resources.
The collection of ModuleHyperlink resources
Retrieves the collection of ModuleHyperlink resources.
The collection of ModuleAttachment resources
Retrieves the collection of ModuleAttachment resources.
The collection of ModuleSearchResult resources
Retrieves the collection of ModuleSearchResult resources.
The collection of SuggestionSearch resources
Retrieves the collection of SuggestionSearch resources.
The collection of GuidelineSearchResult resources
Retrieves the collection of GuidelineSearchResult resources.
Retrieves the collection of NewsItem resources.
The collection of GuidelineNavigation resources
Retrieves the collection of GuidelineNavigation resources.
Retrieves the collection of Guideline resources.
The collection of Organisation resources
Retrieves the collection of Organisation resources.
Retrieves the collection of Favourite resources.
The collection of Subscription resources
Retrieves the collection of Subscription resources.
The collection of UserNotification resources
Retrieves the collection of UserNotification resources.
The collection of ContentViewLog resources
Retrieves the collection of ContentViewLog resources.
The collection of RecentSearch resources
Retrieves the collection of RecentSearch resources.
The message associated with the violation