v3

latestOpenAPI 3.0.3EUPL 1.2raw.githubusercontent.com2023-09-133352279.9 KB

enkelvoudiginformatieobjecten

Een specifiek (ENKELVOUDIG) INFORMATIEOBJECT opvragen.

Het object bevat metadata over het document en de downloadlink (inhoud) naar de binary data. Dit geeft standaard de laatste versie van het (ENKELVOUDIG) INFORMATIEOBJECT. Specifieke versies kunnen middels query-string parameters worden opgevraagd.

get/enkelvoudiginformatieobjecten/{uuid}

Path parameters

uuidstring uuid required

Unieke resource identifier (UUID4)

Query parameters

versieinteger

Het (automatische) versienummer van het INFORMATIEOBJECT.

registratieOpstring

Een datumtijd in ISO8601 formaat. De versie van het INFORMATIEOBJECT die qua begin_registratie het kortst hiervoor zit wordt opgehaald.

expandstring

Example:informatieobjecttype

Haal details van gelinkte resources direct op. Als je meerdere resources tegelijk wilt ophalen kun je deze scheiden met een komma. Voor het ophalen van resources die een laag dieper genest zijn wordt de punt-notatie gebruikt.

Headers

If-None-Matchstring

Voer een voorwaardelijk verzoek uit. Deze header moet één of meerdere ETag-waardes bevatten van resources die de consumer gecached heeft. Indien de waarde van de ETag van de huidige resource voorkomt in deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie MDN voor meer informatie.

Response

urlstring uri required

URL-referentie naar dit object. Dit is de unieke identificatie en locatie van dit object.

identificatiestring

Een binnen een gegeven context ondubbelzinnige referentie naar het INFORMATIEOBJECT.

bronorganisatiestring required

Het RSIN van de Niet-natuurlijk persoon zijnde de organisatie die het informatieobject heeft gecreëerd of heeft ontvangen en als eerste in een samenwerkingsketen heeft vastgelegd.

creatiedatumstring date required

Een datum of een gebeurtenis in de levenscyclus van het INFORMATIEOBJECT.

titelstring required

De naam waaronder het INFORMATIEOBJECT formeel bekend is.

auteurstring required

De persoon of organisatie die in de eerste plaats verantwoordelijk is voor het creëren van de inhoud van het INFORMATIEOBJECT.

formaatstring

Het "Media Type" (voorheen "MIME type") voor de wijze waaropde inhoud van het INFORMATIEOBJECT is vastgelegd in een computerbestand. Voorbeeld: application/msword. Zie: https://www.iana.org/assignments/media-types/media-types.xhtml

taalstring required

Een ISO 639-2/B taalcode waarin de inhoud van het INFORMATIEOBJECT is vastgelegd. Voorbeeld: dut. Zie: https://www.iso.org/standard/4767.html

versieinteger required

Het (automatische) versienummer van het INFORMATIEOBJECT. Deze begint bij 1 als het INFORMATIEOBJECT aangemaakt wordt.

beginRegistratiestring date-time required

Een datumtijd in ISO8601 formaat waarop deze versie van het INFORMATIEOBJECT is aangemaakt of gewijzigd.

bestandsnaamstring

De naam van het fysieke bestand waarin de inhoud van het informatieobject is vastgelegd, inclusief extensie.

inhoudstring uri nullable

Download URL van de binaire inhoud.

bestandsomvanginteger nullable

Aantal bytes dat de inhoud van INFORMATIEOBJECT in beslag neemt.

linkstring uri

De URL waarmee de inhoud van het INFORMATIEOBJECT op te vragen is.

beschrijvingstring

Een generieke beschrijving van de inhoud van het INFORMATIEOBJECT.

ontvangstdatumstring date nullable

<b>DEPRECATED</b> Dit attribuut is verplaatst naar resource Verzending. De datum waarop het INFORMATIEOBJECT ontvangen is. Verplicht te registreren voor INFORMATIEOBJECTen die van buiten de zaakbehandelende organisatie(s) ontvangen zijn. Ontvangst en verzending is voorbehouden aan documenten die van of naar andere personen ontvangen of verzonden zijn waarbij die personen niet deel uit maken van de behandeling van de zaak waarin het document een rol speelt.

verzenddatumstring date nullable

<b>DEPRECATED</b> Dit attribuut is verplaatst naar resource Verzending. De datum waarop het INFORMATIEOBJECT verzonden is, zoals deze op het INFORMATIEOBJECT vermeld is. Dit geldt voor zowel inkomende als uitgaande INFORMATIEOBJECTen. Eenzelfde informatieobject kan niet tegelijk inkomend en uitgaand zijn. Ontvangst en verzending is voorbehouden aan documenten die van of naar andere personen ontvangen of verzonden zijn waarbij die personen niet deel uit maken van de behandeling van de zaak waarin het document een rol speelt.

indicatieGebruiksrechtboolean nullable

Indicatie of er beperkingen gelden aangaande het gebruik van het informatieobject anders dan raadpleging. Dit veld mag null zijn om aan te geven dat de indicatie nog niet bekend is. Als de indicatie gezet is, dan kan je de gebruiksrechten die van toepassing zijn raadplegen via de GEBRUIKSRECHTen resource.

verschijningsvormstring

De essentiële opmaakaspecten van een INFORMATIEOBJECT.

informatieobjecttypestring uri required

URL-referentie naar het INFORMATIEOBJECTTYPE (in de Catalogi API).

lockedboolean required

Geeft aan of het document gelocked is. Alleen als een document gelocked is, mogen er aanpassingen gemaakt worden.

trefwoordenstring[]

Een lijst van één of meer trefwoorden.