Ophalen AFD-definities

Wat is AOS?

• Online tool voor samenstellen van AFD-definities
• Een AFD-definitie bestaat uit een schema en path-expressies
• Ondersteuning voor zowel AFD 1.0 als AFD 2.0
• Meer informatie: afd-online-samenstellen

Ophalen AFD-definities uit register

• AOS bewaart aangemaakte AFD-definities in het SIVI-register voor AFD-definities.

Dit register kent twee manieren voor ontsluiting:

1. Toegang via AOS-webportaal
   1. Een AFD-definitie kan op 3 manieren in het register staan:
      1. Zichtbaar: AFD-definitie naam is zichtbaar voor raadplegers
      2. Downloadbaar: AFD-definitie naam is zichtbaar en downloadbaar voor geautoriseerde raadplegers
      3. Niet zichtbaar: AFD-definitie is onzichtbaar voor raadplegers, alleen de beheerder van het register binnen de organisatie ziet de AFD-definitie
2. Toegang via AOS-API (REST)
   1. Alleen zichtbare AFD-definities kan men opvragen
   2. Ophalen overzicht nieuwe AFD-definities op basis van ‘vanaf-datum’ parameter
   3. Ophalen AFD-definities
      1. Alleen de als downloadbaar aangemerkte AFD-definities kan men ophalen, de andere AFD-definities zal men moeten opvragen bij de betreffende organisatie

Inrichting registratie AFD-definities

Het advies is om op basis van de kenmerken van een AFD-definitie (opgehaald met AOS API) een registratie in te richten (database) van in gebruik zijnde AFD-definities.

Hoe gebruikt u de AOS-API

Doel: periodiek bijwerken van uw administratie (productinrichting) met meest recente AFD-definities

De te volgen stappen zijn:

1. Een overzicht met recente AFD-definities is op te vragen op basis van gekozen vanafdatum.
2. Per gevonden AFD-definitie komt detailinformatie terug. Het advies is op basis van deze kenmerken een registratie in te richten (database) van in gebruik zijnde AFD-definities. Op basis van de kenmerken kunt u controleren of u een AFD-definitie moet actualiseren of toevoegen.
3. Elke gevonden AFD-definitie bevat een sleutel. Met deze sleutel kunt u in de vervolg call de AFD-definitie ophalen en toevoegen aan uw registratie van AFD-definities.
4. Met de opgehaalde AFD-definities kunt u uw eigen omgeving handmatig of geautomatiseerd inrichten of bijwerken.
   

De gedetailleerde technische API-specificatie is beschikbaar via SwaggerHub: https://app.swaggerhub.com/apis/SIVI_API_Framework/AFD-definition/1.1.0