Documenten met bijbehorende metadata kunnen met deze API worden aangeleverd om openbaar gemaakt te worden met PLOOI. Ook kan deze API gebruikt worden om aangeleverde documenten en metadata bij te werken.

Een document is volgens de Woo (geparafraseerd):

een door een orgaan, persoon of college als bedoeld in artikel 2.2, eerste lid, opgemaakt of ontvangen schriftelijk stuk of ander geheel van vastgelegde gegevens dat naar zijn aard verband houdt met de publieke taak van dat orgaan, die persoon of dat college

Kijk ook op het PLOOI-portaal voor reeds openbaar gemaakte documenten.

Voor het vindbaar maken van documenten, is (gestructureerde) metadata nodig. Voor het aanleveren bij PLOOI betekent dat, dat alle documenten moeten zijn voorzien van metadata die voldoen aan voorschriften ten aanzien van vorm en inhoud. Bij deze metadata onderscheiden we drie categorieën:

• generieke verplichte metadata
• generieke optionele metadata
• organisatie- of documentspecifieke metadata PLOOI controleert de veldnamen en de waarden in de metadata en geeft feedback over de details indien er afwijkingen worden geconstateerd.

Het (initieel) aanleveren van een document verloopt langs het volgende proces:

1. Een organisatie levert de bij het document behorende metadata aan via de API met DigiKoppeling (zie hieronder voor details)
2. PLOOI controleert
   • of de organisatie geauthenticeerd en geautoriseerd is om documenten aan te leveren
   • of de metadata voldoet aan de voorschriften
3. PLOOI antwoordt
   • als de aanlevering van metadata voldoet: met een API-URL waar het document aangeleverd kan worden
   • als de autorisatie of metadata niet voldoet: een gedetailleerde foutmelding
4. De organisatie levert het document aan bij de API-URL, wederom met DigiKoppeling
5. PLOOI controleert
   • of de organisatie geauthenticeerd en geautoriseerd is om documenten aan te leveren
   • of het bestandsformaat is toegestaan en overeenstemt
   • of er sprake is van malware
6. PLOOI antwoordt
   • met een bevestiging als de aanlevering succesvol was
   • met een foutmelding in de andere gevallen

Hieronder is een interactieve weergave van de OpenAPI Specification van deze API opgenomen.

Deze Open API Specification kan ook worden gedownload als enkelvoudig, gebundeld bestand: Download

TIP1: klik op de methode in het donkere gedeelte rechts om de HTTP-URI weer te geven.

TIP2: in de boomstructuur hieronder: klik op een aftakking om deze uit of in te klappen.