Figuur 2: Aanroep API ophalen AFD-definities.
GET publication-info
Deze call geeft een overzicht van alle (als zichtbaar aangemerkte) AFD-definities welke gepubliceerd zijn met ingang van de opgegeven datum. Per AFD-definitie is aangegeven of deze ook te downloaden is.
INPUT: ‘Datum vanaf’ parameter
Endpoint: https://portal.sivi.org/api/afd-definitions/publication-info?fromDate=YYYY-MM-DD
OUTPUT: Lijst met AFD-definities aangeboden in 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 |
GET afd-definitions
Met deze call kan een (als downloadbaar aangemerkte) AFD-definitie, als Base64 geëncodeerde content, worden opgehaald.
INPUT: ‘organisationName’ en ‘afdDefinitionName’
Endpoint: https://portal.sivi.org/api/afd-definitions/{organisationName}/{definitionName}
OUTPUT: AFD-definitie wordt aangeboden in structuur met twee elementen:
| Veld | Datatype | Omschrijving |
| fileName | String | Bestandsnaam van opgehaalde AFD-definitie |
| fileContent | String | AFD-definitiebestand (zip) als geëncodeerde Base64 content |
Reactie
Powered by
Geef uw reactie op dit onderwerp.