drc.api package

drc.api.serializers module

Serializers of the Document Registratie Component REST API

class drc.api.serializers.AnyBase64File(view_name: str = None, *args, **kwargs)

Bases: drf_extra_fields.fields.Base64FileField

to_internal_value(base64_data)

Transform the incoming primitive data into a native value.

to_representation(file)

Transform the outgoing native value into primitive data.

class drc.api.serializers.EnkelvoudigInformatieObjectHyperlinkedRelatedField(view_name=None, **kwargs)

Bases: rest_framework.relations.HyperlinkedRelatedField

Custom field to construct the url for models that have a ForeignKey to EnkelvoudigInformatieObject

Needed because the canonical EnkelvoudigInformatieObjectCanonical no longer stores the uuid, but the EnkelvoudigInformatieObjects related to it do store the uuid

get_object(view_name, view_args, view_kwargs)

Return the object corresponding to a matched URL.

Takes the matched URL conf arguments, and should return an object instance, or raise an ObjectDoesNotExist exception.

get_url(obj, view_name, request, format)

Given an object, return the URL that hyperlinks to the object.

May raise a NoReverseMatch if the view_name and lookup_field attributes are not configured to correctly match the URL conf.

class drc.api.serializers.EnkelvoudigInformatieObjectSerializer(*args, **kwargs)

Bases: rest_framework.serializers.HyperlinkedModelSerializer

Serializer for the EnkelvoudigInformatieObject model

create(validated_data)

Handle nested writes.

update(instance, validated_data)

Instead of updating an existing EnkelvoudigInformatieObject, create a new EnkelvoudigInformatieObject with the same EnkelvoudigInformatieObjectCanonical

class drc.api.serializers.EnkelvoudigInformatieObjectWithLockSerializer(*args, **kwargs)

Bases: drc.api.serializers.EnkelvoudigInformatieObjectSerializer

This serializer class is used by EnkelvoudigInformatieObjectViewSet for update and partial_update operations

class drc.api.serializers.GebruiksrechtenSerializer(instance=None, data=<class 'rest_framework.fields.empty'>, **kwargs)

Bases: rest_framework.serializers.HyperlinkedModelSerializer

class drc.api.serializers.IntegriteitSerializer(*args, **kwargs)

Bases: vng_api_common.serializers.GegevensGroepSerializer

class drc.api.serializers.LockEnkelvoudigInformatieObjectSerializer(instance=None, data=<class 'rest_framework.fields.empty'>, **kwargs)

Bases: rest_framework.serializers.ModelSerializer

Serializer for the lock action of EnkelvoudigInformatieObjectCanonical model

class drc.api.serializers.ObjectInformatieObjectSerializer(*args, **kwargs)

Bases: rest_framework.serializers.HyperlinkedModelSerializer

class drc.api.serializers.OndertekeningSerializer(*args, **kwargs)

Bases: vng_api_common.serializers.GegevensGroepSerializer

class drc.api.serializers.UnlockEnkelvoudigInformatieObjectSerializer(instance=None, data=<class 'rest_framework.fields.empty'>, **kwargs)

Bases: rest_framework.serializers.ModelSerializer

Serializer for the unlock action of EnkelvoudigInformatieObjectCanonical model

drc.api.urls module

drc.api.viewsets module

class drc.api.viewsets.EnkelvoudigInformatieObjectAuditTrailViewSet(**kwargs)

Bases: vng_api_common.audittrails.viewsets.AuditTrailViewSet

Opvragen van de audit trail regels.

list: Alle audit trail regels behorend bij het INFORMATIEOBJECT.

Alle audit trail regels behorend bij het INFORMATIEOBJECT.

retrieve: Een specifieke audit trail regel opvragen.

Een specifieke audit trail regel opvragen.

class drc.api.viewsets.EnkelvoudigInformatieObjectViewSet(**kwargs)

Bases: vng_api_common.notifications.viewsets.NotificationViewSetMixin, vng_api_common.viewsets.CheckQueryParamsMixin, drc.api.data_filtering.ListFilterByAuthorizationsMixin, vng_api_common.audittrails.viewsets.AuditTrailViewsetMixin, rest_framework.viewsets.ModelViewSet

Opvragen en bewerken van (ENKELVOUDIG) INFORMATIEOBJECTen (documenten).

create: Maak een (ENKELVOUDIG) INFORMATIEOBJECT aan.

Er wordt gevalideerd op - geldigheid informatieobjecttype URL - de resource moet opgevraagd kunnen

worden uit de catalogi API en de vorm van een INFORMATIEOBJECTTYPE hebben.
  • publicatie informatieobjecttype - concept moet false zijn

list: Alle (ENKELVOUDIGe) INFORMATIEOBJECTen opvragen.

Deze lijst kan gefilterd wordt met query-string parameters.

De objecten bevatten metadata over de documenten en de downloadlink (inhoud) naar de binary data. Alleen de laatste versie van elk (ENKELVOUDIG) INFORMATIEOBJECT wordt getoond. Specifieke versies kunnen alleen

retrieve: 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.

update: Werk een (ENKELVOUDIG) INFORMATIEOBJECT in zijn geheel bij.

Dit creëert altijd een nieuwe versie van het (ENKELVOUDIG) INFORMATIEOBJECT.

Er wordt gevalideerd op - correcte lock waarde - geldigheid informatieobjecttype URL - de resource moet opgevraagd kunnen

worden uit de catalogi API en de vorm van een INFORMATIEOBJECTTYPE hebben.
  • publicatie informatieobjecttype - concept moet false zijn
  • status NIET definitief

TODO - valideer immutable attributes

partial_update: Werk een (ENKELVOUDIG) INFORMATIEOBJECT deels bij.

Dit creëert altijd een nieuwe versie van het (ENKELVOUDIG) INFORMATIEOBJECT.

Er wordt gevalideerd op - correcte lock waarde - geldigheid informatieobjecttype URL - de resource moet opgevraagd kunnen

worden uit de catalogi API en de vorm van een INFORMATIEOBJECTTYPE hebben.
  • publicatie informatieobjecttype - concept moet false zijn
  • status NIET definitief

TODO - valideer immutable attributes

destroy: Verwijder een (ENKELVOUDIG) INFORMATIEOBJECT.

Verwijder een (ENKELVOUDIG) INFORMATIEOBJECT en alle bijbehorende versies, samen met alle gerelateerde resources binnen deze API. Dit is alleen mogelijk als er geen OBJECTINFORMATIEOBJECTen relateerd zijn aan het (ENKELVOUDIG) INFORMATIEOBJECT.

Gerelateerde resources - GEBRUIKSRECHTen - audit trail regels

download: Download de binaire data van het (ENKELVOUDIG) INFORMATIEOBJECT.

Download de binaire data van het (ENKELVOUDIG) INFORMATIEOBJECT.

lock: Vergrendel een (ENKELVOUDIG) INFORMATIEOBJECT.

Voert een “checkout” uit waardoor het (ENKELVOUDIG) INFORMATIEOBJECT vergrendeld wordt met een lock waarde. Alleen met deze waarde kan het (ENKELVOUDIG) INFORMATIEOBJECT bijgewerkt (PUT, PATCH) en weer ontgrendeld worden.

unlock: Ontgrendel een (ENKELVOUDIG) INFORMATIEOBJECT.

Heft de “checkout” op waardoor het (ENKELVOUDIG) INFORMATIEOBJECT ontgrendeld wordt.

filterset_class

To support filtering by versie and registratieOp for detail view

get_renderers()

Instantiates and returns the list of renderers that this view can use.

get_serializer_class()

To validate that a lock id is sent only with PUT and PATCH operations

pagination_class

alias of rest_framework.pagination.PageNumberPagination

swagger_schema

alias of drc.api.schema.EIOAutoSchema

class drc.api.viewsets.GebruiksrechtenViewSet(**kwargs)

Bases: vng_api_common.notifications.viewsets.NotificationViewSetMixin, vng_api_common.viewsets.CheckQueryParamsMixin, drc.api.data_filtering.ListFilterByAuthorizationsMixin, vng_api_common.audittrails.viewsets.AuditTrailViewsetMixin, rest_framework.viewsets.ModelViewSet

Opvragen en bewerken van GEBRUIKSRECHTen bij een INFORMATIEOBJECT.

create: Maak een GEBRUIKSRECHT aan.

Voeg GEBRUIKSRECHTen toe voor een INFORMATIEOBJECT.

Opmerkingen
  • Het toevoegen van gebruiksrechten zorgt ervoor dat de indicatieGebruiksrecht op het informatieobject op true gezet wordt.

list: Alle GEBRUIKSRECHTen opvragen.

Deze lijst kan gefilterd wordt met query-string parameters.

retrieve: Een specifieke GEBRUIKSRECHT opvragen.

Een specifieke GEBRUIKSRECHT opvragen.

update: Werk een GEBRUIKSRECHT in zijn geheel bij.

Werk een GEBRUIKSRECHT in zijn geheel bij.

partial_update: Werk een GEBRUIKSRECHT relatie deels bij.

Werk een GEBRUIKSRECHT relatie deels bij.

destroy: Verwijder een GEBRUIKSRECHT.

Opmerkingen
  • Indien het laatste GEBRUIKSRECHT van een INFORMATIEOBJECT verwijderd wordt, dan wordt de indicatieGebruiksrecht van het INFORMATIEOBJECT op null gezet.
filterset_class

alias of drc.api.filters.GebruiksrechtenFilter

serializer_class

alias of drc.api.serializers.GebruiksrechtenSerializer

class drc.api.viewsets.ObjectInformatieObjectViewSet(**kwargs)

Bases: vng_api_common.viewsets.CheckQueryParamsMixin, drc.api.data_filtering.ListFilterByAuthorizationsMixin, rest_framework.mixins.CreateModelMixin, rest_framework.mixins.DestroyModelMixin, rest_framework.viewsets.ReadOnlyModelViewSet

Opvragen en verwijderen van OBJECT-INFORMATIEOBJECT relaties.

Het betreft een relatie tussen een willekeurig OBJECT, bijvoorbeeld een ZAAK in de Zaken API, en een INFORMATIEOBJECT.

create: Maak een OBJECT-INFORMATIEOBJECT relatie aan.

LET OP: Dit endpoint hoor je als consumer niet zelf aan te spreken.

Andere API’s, zoals de Zaken API en de Besluiten API, gebruiken dit endpoint bij het synchroniseren van relaties.

Er wordt gevalideerd op - geldigheid informatieobject URL - de combinatie informatieobject en object moet uniek zijn - bestaan van object URL

list: Alle OBJECT-INFORMATIEOBJECT relaties opvragen.

Deze lijst kan gefilterd wordt met query-string parameters.

retrieve: Een specifieke OBJECT-INFORMATIEOBJECT relatie opvragen.

Een specifieke OBJECT-INFORMATIEOBJECT relatie opvragen.

destroy: Verwijder een OBJECT-INFORMATIEOBJECT relatie.

LET OP: Dit endpoint hoor je als consumer niet zelf aan te spreken.

Andere API’s, zoals de Zaken API en de Besluiten API, gebruiken dit endpoint bij het synchroniseren van relaties.

filterset_class

alias of drc.api.filters.ObjectInformatieObjectFilter

serializer_class

alias of drc.api.serializers.ObjectInformatieObjectSerializer