Gebruikersverhaal

Als gemeentelijke ontwikkelaar wil ik dat in een Product in de Open Producten API een verbruiksobject kan worden opgeslagen, zodat producten die een bepaalde consumptie, limiet, of herhaalde gebruiksmogelijkheid hebben, efficiënt beheerd en gemonitord kunnen worden. Dit helpt om bijvoorbeeld parkeervergunningen, toeristische verhuur of andere producten met een beperkt aantal gebruiksmomenten nauwkeurig te registreren en beheren.

Waar dit bij andere CG APIs met een URL naar de Objecten API wordt afgedaan, daar willen we met Open Producten een stap verder in gaan door niet langer de client naar een ander component te verwijzen maar dit binnen Open Producten op te lossen. Dit maakt het gebruik van de Open Producten API eenvoudiger en verbetert de performance door meerdere aanroepen te vermijden.

Mijn beeld hierbij is dat we een JSON field hebben, en dat je in de admin de JSON schema kan configureren voor het veld. Dit patroon zal meerdere keren voorkomen in Open Producten, en wat mij betreft maken we hier ook een kleine library voor.

Acceptatiecriteria

Verbruiksobject

• Het datamodel bevat een nieuw veld verbruiksobject binnen de Product-entiteit.
• Verbruiksobject data is JSON op basis van een JSON schema (mag willekeurige data bevatten maar moet conform een door een beheerder in te stellen JSON schema zijn opgesteld)
• Producten API ondersteunt het ophalen van extra informatie over het verbruiksobject zoals tellers, gebruiksfrequentie en datums.

API-functionaliteit

• Bij het aanmaken of bewerken van een product (POST/PUT), moet de verbruiksobject data meegestuurd kunnen worden en gevalideerd worden tegen JSON schema
• De Open Producten API ondersteunt het opvragen van producten met bijbehorende verbruiksobjecten (GET /producten)