De AOS-API bevat twee actuele functies:
- GET afd-definitions/published-items: Voor het ophalen van een overzicht van AFD-definities/OpenAPI Descriptions 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/published-items
Deze call geeft een overzicht terug van alle (als zichtbaar aangemerkte) AFD-definities en OpenAPI Descriptions die gepubliceerd zijn in het AOS-register, met ingang van de opgegeven datum. Per item wordt in de response aangegeven wat het itemtype is (isOpenApiDescription: true/false) en of deze ook te downloaden is (isDownloadable: true/false). Het overzicht is gemakkelijk om te zetten naar een tabel of op te slaan in een database.
Voorbeeld verwerken API-response in tabel/database
Het endpoint bevat een ‘Datum vanaf’ parameter:
https://portal.sivi.org/api/afd-definitions/published-items?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/published-items?fromDate=2024-01-01De response bevat een lijst met de inhoud van het AOS-register (AFD-definities en OpenAPI Descriptions) aangeboden in JSON-structuur met per item de volgende elementen:
| Veld | Datatype | Omschrijving |
| publicationDate | String ($date-time) | Datum van publicatie van AFD-definitie |
| businessLine | String | Branchecode waar AFD-definitie betrekking op heeft |
| porCompany | String | POR-code van eigenaar AFD-definitie |
| afdDefinitionOwner | String | Naam organisatie eigenaar AFD-definitie |
| afdDefinitionName | String | Naam van AFD-definitie |
| afdDefinitionVersion | String | Versienummer van AFD-definitie |
| basedOnBaseline | String | Baseline waarop AFD-definitie gebaseerd is |
| afdDefinitionTag | String | Label dat aan AFD-definitie kan worden gegeven zodat kan worden gezocht en gegroepeerd |
| isDownloadable | Boolean (true/false) | Indicator of AFD-definitie downloadbaar is |
| isOpenApiDescription | Boolean (true/false) | Indicator of het een OpenAPI Description betreft |
| afdDefinitionVariantName | String | Naam van AFD-definitie-variant |
| afdDefinitionVariantVersion | String | Versienummer van AFD-definitie-variant |
Tabel met responsegegevens
GET afd-definitions
Met deze call kan een als downloadbaar aangemerkt item (AFD-definitie of OpenAPI Description), als Base64 geëncodeerde content, worden gedownload.
Het endpoint bevat ‘afdDefinitionOwner’ en ‘afdDefinitionName’ parameters:
https://portal.sivi.org/api/afd-definitions/<afdDefinitionOwner>/<afdDefinitionName>Vervang hierbij de gegevens tussen de kleiner dan (<) en de groter dan (>) tekens met de waarde van afdDefinitionOwner 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/050-A009-Inboedel-001.45De response bevat de bestandsnaam en de content van de opgevraagde registeritem welke wordt aangeboden in een JSON-structuur met twee elementen:
| Veld | Datatype | Omschrijving |
| fileName | String | Bestandsnaam van opgehaalde AFD-definitie |
| fileContent | String | Registeritem (zip) als geëncodeerde Base64 content |
Om van de fileContent-string een AFD-definitie/OAD (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.
GET afd-definitions/publication-info NIET voor nieuwe toepassingen – archiefdocumentatie voor oude implementaties
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