Zoek context
POST/context/zoek
Retourneert een samengesteld object met klantgerelateerde gegevens voor
de opgegeven klant en optionele context. Via de include-parameter
bepaalt de aanroeper welke resource-typen worden meegeleverd.
Dit endpoint is bedoeld om verschillende overzichts- en contextschermen te bedienen vanuit één call. Voorbeelden:
| Scherm | contextId | include |
|---|---|---|
| MijnTaken | — | ["taken"] |
| Overzicht per domein | — | ["taken", "contactmomenten"] |
| Zaak-contextscherm | urn:nl:gemeenten:zaak:2026-00042 | ["taken", "contactmomenten"] |
Initieel wordt alleen taken ondersteund. Nieuwe resource-typen
kunnen worden toegevoegd zonder bestaande implementaties te breken:
clients negeren typen die ze niet kennen.
Ontwerpkeuze — POST als query:
Deze operatie gebruikt POST omdat de filtercriteria in de request body
worden meegegeven. Qua semantiek gedraagt de operatie zich als de
HTTP QUERY method (IETF-draft):
zij is safe — de aanroep heeft geen neveneffecten en wijzigt geen
toestand op de server. Portalen mogen de aanroep dan ook als zodanig
behandelen — herhalen bij netwerkstoringen, optimistisch prefetchen, etc.
Zodra HTTP QUERY breed ondersteund wordt door clients en gateways, kan
dit endpoint zonder gedragswijziging worden gemigreerd.
Request
Responses
- 200
- 400
- 401
Succesvol
Response Headers
Versie van de API die de respons heeft gegenereerd.
Ongeldige aanvraag
Authenticatie vereist