Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

verzoektype URLs toevoegen aan producttype, relaties naar zaaktypes #15

Open
alextreme opened this issue Nov 24, 2024 · 0 comments
Open
Labels
enhancement New feature or request

Comments

@alextreme
Copy link
Member

alextreme commented Nov 24, 2024

Gebruikersverhaal

Als gemeentelijke ontwikkelaar
wil ik dat een ProductType relaties kan hebben naar VerzoekType, Processen en ZaakType,
zodat producten kunnen worden gekoppeld aan de juiste gemeentelijke processen, verzoektypen en zaaktypen op een gestandaardiseerde manier met behulp van URNs.


Acceptatiecriteria

Relaties in ProductType

  • Het datamodel van de ProductType-entiteit bevat velden voor het leggen van relaties:
    • verzoektype: Een optionele relatie (0 of 1) naar een VerzoekType, opgeslagen als een URN (bijv. urn:gemeente-utrecht:verzoektype:12345).
    • processen: Een optionele lijst met relaties (0, 1 of meerdere) naar Processen, opgeslagen als URNs (bijv. urn:gemeente-utrecht:proces:123).
    • zaaktypen: Een optionele lijst met relaties (0, 1 of meerdere) naar ZaakTypen, opgeslagen als URNs (bijv. urn:gemeente-utrecht:zaaktype:456).

Validatie

  • Bij het aanmaken of wijzigen van een ProductType valideert de API:
    • Dat elke relatie een geldige URN is die voldoet aan de URN-standaard.
    • Dat relaties uniek zijn binnen hun respectieve lijst (bijv. geen dubbele Processen-URNs).
  • Bij foutieve invoer retourneert de API duidelijke foutmeldingen in het Nederlands, zoals:
    • "De opgegeven URN voor VerzoekType is niet geldig."
    • "De URN 'urn:gemeente-utrecht:proces:123' is al gekoppeld aan dit ProductType."

API-functionaliteit

  • Bij het opvragen van een ProductType retourneert de API de gekoppelde URNs voor:
    • verzoektype
    • processen
    • zaaktypen
  • Filtering op basis van deze relaties wordt ondersteund in de API (bijv. GET /producttypen?zaaktypen=urn:gemeente-utrecht:zaaktype:456).
  • Endpoints voor het beheren van deze relaties ondersteunen het toevoegen, wijzigen of verwijderen van URNs.

Documentatie

  • De API-documentatie bevat voorbeelden van het instellen, opvragen en beheren van relaties naar VerzoekType, Processen en ZaakType.
  • Voorbeeld-API-aanvragen tonen hoe URNs kunnen worden gebruikt in gemeentelijke integraties.

Definition of Done (DoD)

  • Velden voor verzoektype, processen en zaaktypen zijn toegevoegd aan het ProductType-datamodel en geïmplementeerd in de API.
  • De API ondersteunt het beheren en opvragen van deze relaties op basis van URNs.
  • Validatie en foutafhandeling zijn volledig geïmplementeerd.
  • Filtering en querying op basis van deze relaties werken zoals beschreven en zijn getest.
  • Documentatie is bijgewerkt met uitleg, voorbeelden, en validatieregels.
@alextreme alextreme added the enhancement New feature or request label Nov 24, 2024
@alextreme alextreme transferred this issue from maykinmedia/open-producten-prototype Dec 3, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant