De AOS-API bevat twee functies:
- GET afd-definitions/publication-info: Voor het ophalen van een overzicht van nieuwe AFD-definities op basis van de ‘vanaf-datum’ parameter.
- GET afd-definitions: Voor het (per stuk) downloaden van AFD-definities (zip-files).
Schematische weergave aanroep API ophalen AFD-definities
GET afd-definitions/publication-info
Deze call geeft een overzicht terug van alle (als zichtbaar aangemerkte) AFD-definities die gepubliceerd zijn in het AOS-register, met ingang van de opgegeven datum. Per AFD-definitie is aangegeven of deze ook te downloaden is (downloadable: true/false).
Voorbeeld verwerken API-response in tabel/database
Endpoint met ‘Datum vanaf’ parameter:
https://portal.sivi.org/api/afd-definitions/publication-info?fromDate=<YYYY-MM-DD>Vervang hierbij de gegevens tussen de kleiner dan (<) en de groter dan (>) tekens met de gewenste datum. Let er hierbij op die tekens zelf ook te verwijderen.
Voorbeeld:
https://portal.sivi.org/api/afd-definitions/publication-info?fromDate=<2024-01-01>De response bevat een lijst met AFD-definities aangeboden in JSON-structuur met per AFD-definitie de volgende elementen:
| Veld | Datatype | Omschrijving |
| organisationName | String | Naam organisatie eigenaar AFD-definitie |
| afdDefinitionName | String | Naam van AFD-definitie |
| publishDate | String ($date-time) | Datum van publicatie van AFD-definitie |
| downloadable | Boolean (true/false) | Indicator of AFD-definitie downloadbaar is |
| afdDefinitionVersion | String | Versienummer van AFD-definitie |
| basedOn | String | Baseline waarop AFD-definitie gebaseerd is |
| brancheCode | String | Branchecode waar AFD-definitie betrekking op heeft |
| porCode | String | POR-code van eigenaar AFD-definitie |
| tag | String | Label dat aan AFD-definitie kan worden gegeven zodat kan worden gezocht en gegroepeerd |
| variantName | String | Naam van AFD-definitie-variant |
| variantVersion | String | Versienummer van AFD-definitie-variant |
Tabel met responsegegevens
GET afd-definitions
Met deze call kan een (als downloadbaar aangemerkte) AFD-definitie, als Base64 geëncodeerde content, worden gedownload.
Endpoint met ‘organisationName’ en ‘definitionName’ parameters:
https://portal.sivi.org/api/afd-definitions/<organisationName>/<definitionName>Vervang hierbij de gegevens tussen de kleiner dan (<) en de groter dan (>) tekens met de organisationName en afdDefinitionName die je bij de vorige call hebt ontvangen en waarbij downloadable = true. Let er hierbij op die tekens zelf ook te verwijderen.
Voorbeeld:
https://portal.sivi.org/api/afd-definitions/SIVI/VBPUO-001.00>De response bevat de naam en de content van de opgevraagde AFD-definitie welke wordt aangeboden in een JSON-structuur met twee elementen:
| Veld | Datatype | Omschrijving |
| fileName | String | Bestandsnaam van opgehaalde AFD-definitie |
| fileContent | String | AFD-definitiebestand (zip) als geëncodeerde Base64 content |
Om van de fileContent-string een AFD-definitie (zip) te maken dienen de ASCII-tekens omgezet te worden in binaire code door deze met Base64 te decoderen en het binaire bestand de bestandsnaam uit de fileName-string te geven.
Geef uw reactie op dit onderwerp.