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

Organisatie aanvullen met code, organisatiecode #7

Open
alextreme opened this issue Nov 8, 2024 · 0 comments
Open

Organisatie aanvullen met code, organisatiecode #7

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

Comments

@alextreme
Copy link
Member

alextreme commented Nov 8, 2024

Gebruikersverhaal

Als gemeentelijke ontwikkelaar
wil ik dat elke Organisatie in de Open Producten API een unieke organisatiecode heeft
zodat deze organisaties eenduidig kunnen worden geïdentificeerd en gekoppeld aan processen, producten, en andere systemen binnen de gemeentelijke infrastructuur. Dit voorkomt ambiguïteit en maakt efficiënte integraties mogelijk.


Acceptatiecriteria

Organisatiecode veld

  • Het datamodel van de Organisatie-entiteit bevat een nieuw veld organisatiecode.
  • De organisatiecode is een verplicht veld en bestaat uit een unieke, alfanumerieke string (bijv. "ORG-001", "UTR-GM-2024").
  • De organisatiecode wordt consistent toegepast in alle relevante API-endpoints en responses.

Uniciteit en validatie

  • De organisatiecode moet uniek zijn binnen de dataset van alle organisaties.
  • Bij een invoer van een duplicaat of een ontbrekende organisatiecode geeft de API een duidelijke foutmelding in het Nederlands, zoals:
    • "Organisatiecode is al in gebruik."
    • "Organisatiecode is verplicht."

Gebruik en filtering

  • De Open Producten API ondersteunt filtering op organisatiecode bij het opvragen van gegevens.

Documentatie

  • De API-documentatie bevat een beschrijving van het gebruik van de organisatiecode en een toelichting op de structuur en validatieregels.

Definition of Done (DoD)

  • Het organisatiecode-veld is toegevoegd aan het datamodel en geïmplementeerd in de API.
  • Unit tests en integratietests controleren de validatie van unieke en verplichte organisatiecodes.
  • Documentatie is bijgewerkt met uitleg, voorbeelden, en validatieregels.
  • Filtering op organisatiecode werkt zoals beschreven en wordt getest in relevante API-endpoints.
@alextreme alextreme added the enhancement New feature or request label Nov 8, 2024
@alextreme alextreme transferred this issue from maykinmedia/open-producten-prototype Dec 3, 2024
@Floris272 Floris272 self-assigned this Dec 17, 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

2 participants