brc.api package

brc.api.serializers module

Serializers of the Besluit Registratie Component REST API

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

Bases: rest_framework.serializers.HyperlinkedModelSerializer

class brc.api.serializers.BesluitSerializer(*args, **kwargs)

Bases: rest_framework.serializers.HyperlinkedModelSerializer

create(validated_data)

We have a bit of extra checking around this in order to provide descriptive messages when something goes wrong, but this method is essentially just:

return ExampleModel.objects.create(**validated_data)

If there are many to many fields present on the instance then they cannot be set until the model is instantiated, in which case the implementation is like so:

example_relationship = validated_data.pop(‘example_relationship’) instance = ExampleModel.objects.create(**validated_data) instance.example_relationship = example_relationship return instance

The default implementation also does not handle nested relationships. If you want to support writable nested relationships you’ll need to write an explicit .create() method.

brc.api.urls module

brc.api.viewsets module

class brc.api.viewsets.BesluitAuditTrailViewSet(**kwargs)

Bases: vng_api_common.audittrails.viewsets.AuditTrailViewSet

Opvragen van de audit trail regels.

list: Alle audit trail regels behorend bij het BESLUIT.

Alle audit trail regels behorend bij het BESLUIT.

retrieve: Een specifieke audit trail regel opvragen.

Een specifieke audit trail regel opvragen.

class brc.api.viewsets.BesluitInformatieObjectViewSet(**kwargs)

Bases: vng_api_common.notifications.viewsets.NotificationCreateMixin, vng_api_common.notifications.viewsets.NotificationDestroyMixin, vng_api_common.audittrails.viewsets.AuditTrailCreateMixin, vng_api_common.audittrails.viewsets.AuditTrailDestroyMixin, vng_api_common.viewsets.CheckQueryParamsMixin, brc.api.data_filtering.ListFilterByAuthorizationsMixin, rest_framework.mixins.CreateModelMixin, rest_framework.mixins.DestroyModelMixin, rest_framework.viewsets.ReadOnlyModelViewSet

Opvragen en bewerken van BESLUIT-INFORMATIEOBJECT relaties.

create: Maak een BESLUIT-INFORMATIEOBJECT relatie aan.

Registreer een INFORMATIEOBJECT bij een BESLUIT. Er worden twee types van relaties met andere objecten gerealiseerd:

Er wordt gevalideerd op - geldigheid besluit URL - geldigheid informatieobject URL - de combinatie informatieobject en besluit moet uniek zijn - informatieobject.informatieobjecttype moet in het ZTC gerelateerd zijn

aan besluit.besluittype

Opmerkingen - De registratiedatum wordt door het systeem op ‘NU’ gezet. De

aardRelatie wordt ook door het systeem gezet.
  • Bij het aanmaken wordt ook in de Documenten API de gespiegelde relatie aangemaakt, echter zonder de relatie-informatie.

list: Alle BESLUIT-INFORMATIEOBJECT relaties opvragen.

Deze lijst kan gefilterd wordt met query-string parameters.

retrieve: Een specifieke BESLUIT-INFORMATIEOBJECT relatie opvragen.

Een specifieke BESLUIT-INFORMATIEOBJECT relatie opvragen.

update: Werk een BESLUIT-INFORMATIEOBJECT relatie in zijn geheel bij.

Je mag enkel de gegevens van de relatie bewerken, en niet de relatie zelf aanpassen.

Er wordt gevalideerd op - informatieobject URL en besluit URL mogen niet veranderen

partial_update: Werk een BESLUIT-INFORMATIEOBJECT relatie deels bij.

Je mag enkel de gegevens van de relatie bewerken, en niet de relatie zelf aanpassen.

Er wordt gevalideerd op - informatieobject URL en besluit URL mogen niet veranderen

destroy: Verwijder een BESLUIT-INFORMATIEOBJECT relatie.

Verwijder een BESLUIT-INFORMATIEOBJECT relatie.

filterset_class

alias of brc.api.filters.BesluitInformatieObjectFilter

get_queryset()

Get the list of items for this view. This must be an iterable, and may be a queryset. Defaults to using self.queryset.

This method should always be used rather than accessing self.queryset directly, as self.queryset gets evaluated only once, and those results are cached for all subsequent requests.

You may want to override this if you need to provide different querysets depending on the incoming request.

(Eg. return a list of items that is specific to the user)

serializer_class

alias of brc.api.serializers.BesluitInformatieObjectSerializer

class brc.api.viewsets.BesluitViewSet(**kwargs)

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

Opvragen en bewerken van BESLUITen.

create: Maak een BESLUIT aan.

Indien geen identificatie gegeven is, dan wordt deze automatisch gegenereerd.

Er wordt gevalideerd op: - uniciteit van verantwoorlijkeOrganisatie + identificatie - geldigheid verantwoorlijkeOrganisatie RSIN - geldigheid besluittype URL - de resource moet opgevraagd kunnen

worden uit de Catalogi API en de vorm van een BESLUITTYPE hebben.
  • geldigheid zaak URL - de resource moet opgevraagd kunnen worden uit de Zaken API en de vorm van een ZAAK hebben.
  • datum in het verleden of nu
  • publicatie besluittype - concept moet false zijn

list: Alle BESLUITen opvragen.

Deze lijst kan gefilterd wordt met query-string parameters.

retrieve: Een specifiek BESLUIT opvragen.

Een specifiek BESLUIT opvragen.

update: Werk een BESLUIT in zijn geheel bij.

Er wordt gevalideerd op: - uniciteit van verantwoorlijkeOrganisatie + identificatie - geldigheid verantwoorlijkeOrganisatie RSIN - het besluittype mag niet gewijzigd worden - geldigheid zaak URL - de resource moet opgevraagd kunnen worden

uit de Zaken API en de vorm van een ZAAK hebben.
  • datum in het verleden of nu
  • publicatie besluittype - concept moet false zijn

partial_update: Werk een BESLUIT deels bij.

Er wordt gevalideerd op: - uniciteit van verantwoorlijkeOrganisatie + identificatie - geldigheid verantwoorlijkeOrganisatie RSIN - het besluittype mag niet gewijzigd worden - geldigheid zaak URL - de resource moet opgevraagd kunnen worden

uit de Zaken API en de vorm van een ZAAK hebben.
  • datum in het verleden of nu
  • publicatie besluittype - concept moet false zijn

destroy: Verwijder een BESLUIT.

Verwijder een BESLUIT samen met alle gerelateerde resources binnen deze API.

De gerelateerde resources zijn - BESLUITINFORMATIEOBJECT - audit trail regels

filter_class

alias of brc.api.filters.BesluitFilter

pagination_class

alias of rest_framework.pagination.PageNumberPagination

serializer_class

alias of brc.api.serializers.BesluitSerializer