Referentiedata
Referentiedata zijn vaste waarden die worden gebruikt om andere gegevens te beschrijven, te classificeren of te valideren. Referentiedata kan gezien worden als metadata omdat ze context en betekenis van de primaire gegevens verstrekken. Referentiedata zijn belangrijk voor de kwaliteit, consistentie en interoperabiliteit van gegevens in verschillende systemen of domeinen.
Referentiedata[bewerken | brontekst bewerken]
VERA legt referentiedata vast als waardereeksen (enumeraties). Bijvoorbeeld de waardereeks van soorten eenheden met waarden als: ‘Woonruimte’, ‘Bedrijfsruimte’, ‘Parkeergelegenheid’, enzovoorts. Deze waardereeksen worden ‘Referentiedatasoorten’ genoemd.
Iedere waarde bestaat uit een drieletterige code, een naam en omschrijving.
Publicatie[bewerken | brontekst bewerken]
Referentiedata wordt door VERA regelmatig bijgewerkt. De versionering en publicatie van referentiedata is onafhankelijk van die van het datamodel en de koppelvlakdefinities (OpenAPI specificaties).
Referentiedata wordt in de vorm van een .csv bestand gepubliceerd op GitHub.
Mis je waarden? Geef dit dan door als 'issue' in GitHub of stuur een mail naar:vera@aedesdatastandaarden.nl
Downloads: * Laatste versie VERA Referentiedata
Naast het .CSV bestand is er ook een API beschikbaar om de referentie data op te vragen (OpenAPI-definitie is te vinden op: https://vera-service.azurewebsites.net/swagger/index.html)
Er zijn 2 endpoints beschikbaar waarop de referentiedata opgevraagd kan worden:
- Endpoint voor het opvragen van de volledige referentiedata: https://vera-service.azurewebsites.net/api/referentiedata
- Endpoint voor het het opvragen van referentiedata voor één referentiedata soort: https://vera-service.azurewebsites.net/api/referentiedata/{soort}
Als parameter kan "version" worden meegegeven. Hiermee kan een specifieke versie van de referentiedata worden opgevraagd. Alle beschikbare versies zijn terug te vinden op GitHub via Releases. Wanneer parameter "version" niet is gespecificeerd, dan wordt de meest recente versie teruggegeven. Version wordt ook vermeld in de response header.
- Voorbeeld opvragen referentie data voor versie v4.0.221125: https://vera-service.azurewebsites.net/api/referentiedata?version=v4.0.221125
- Voorbeeld opvragen van referentiedata soort AANBIEDINGSTATUS: https://vera-service.azurewebsites.net/api/referentiedata/AANBIEDINGSTATUS
Referentiedatasoorten[bewerken | brontekst bewerken]
- AANBIEDINGDETAILSTATUS
- AANBIEDINGSTATUS
- AANVULLENDEDOELGROEP
- ACCOUNTSTATUS
- ADRESSOORT
- AFLETTERSTATUS
- AFREKENWIJZESOORT
- AFSPRAAKSTATUS
- AFSPRAAKVERZOEKSOORT
- AFWEZIGHEIDSOORT
- AKTESOORT
- AUTHENTIEKGEGEVENBRON
- AUTHENTIEKGEGEVENBRONSOORT
- AUTHENTIEKGEGEVENSOORT
- AUTHENTIEKGEGEVENSTATUS
- BEDRIJFSOORT
- BEGROTINGVERSIE
- BESTEMMING
- BETAALGEGEVENSOORT
- BETAALWIJZEDEELSOORT
