Referentielijsten (CONCEPT)

Auteur: Joeri Bekker | Status: CONCEPT

Binnen allerlei registraties wordt gebruik gemaakt van (semi) gestandaardiseerde waarden. Denk aan talen en landen. Idealiter wil je dat elke applicatie dezelfde lijst van talen en landen hanteert. Gelukkig zijn talen en landen goed gestandaardiseerd via ISO-standaarden, hoewel ook hier verschillende varianten in zijn (2 letter of 3 letters codes bijvoorbeeld).

Binnen referentielijsten willen we de wat minder gestandaardiseerde lijsten vastleggen zodat deze in de keten van applicaties gebruikt kan worden en niet in elke applicatie apart opgevoerd en gewijzigd hoeft te worden. Denk bijvoorbeeld aan communicatiekanalen (e-mail, WhatsApp, telefoon, Facebook) of soorten registraties (BRP, KVK, RNI).

Overzicht

Component: Docker image | Broncode
API-specificatie: Open API Specificatie
Beschikbare lijsten: Voorlopig, onderaan deze pagina.

Open vragen

Bij lijsten spelen o.a. de volgende vragen:

Is het een landelijke lijst of een gemeentelijke specifieke lijst? Of beide?
- Concept antwoord: Het kan beide.
Draait het al ergens?
- Concept antwoord: Enkel in ontwikkelomgevingen. Er draait nog niets landelijks of in productie.
Is het een openbare lijst of intern?
- Concept antwoord: Openbaar (ofwel, het is niet geheim)
Bestaat de lijst uit enkel codes en/of waarden, of is er meer informatie?
- Concept antwoord: Standaard enkel een code+waarde, maar meer informatie (zonder structuur) is mogelijk.
Moet de lijst separaat worden bijgehouden (als referentielijst) of is de lijst onderdeel van een bepaalde specificatie?
- Concept antwoord: Idealiter moeten lijsten in de API-specificatie staan als ze weinig veranderen en enkel in die registratie gebruikt worden. Dit maakt het leven van ontwikkelaars veel eenvoudiger. Lijsten die wijzigen of gemeente specifiek zijn, of op veel plekken gebruikt worden, kunnen beter op een referentielijst komen. Maar het is dus niet heel zwart-wit.

Beschikbare lijsten

Communicatiekanalen

PreviousKlantinteracties (BEPROEVING)NextProducten (CONCEPT)

Last updated 2 months ago

Open vragen

Bij lijsten spelen o.a. de volgende vragen:

Is het een landelijke lijst of een gemeentelijke specifieke lijst? Of beide?

Concept antwoord: Het kan beide.

Draait het al ergens?

Concept antwoord: Enkel in ontwikkelomgevingen. Er draait nog niets landelijks of in productie.

Is het een openbare lijst of intern?

Concept antwoord: Openbaar (ofwel, het is niet geheim)

Bestaat de lijst uit enkel codes en/of waarden, of is er meer informatie?

Concept antwoord: Standaard enkel een code+waarde, maar meer informatie (zonder structuur) is mogelijk.

Moet de lijst separaat worden bijgehouden (als referentielijst) of is de lijst onderdeel van een bepaalde specificatie?

Concept antwoord: Idealiter moeten lijsten in de API-specificatie staan als ze weinig veranderen en enkel in die registratie gebruikt worden. Dit maakt het leven van ontwikkelaars veel eenvoudiger. Lijsten die wijzigen of gemeente specifiek zijn, of op veel plekken gebruikt worden, kunnen beter op een referentielijst komen. Maar het is dus niet heel zwart-wit.