onadata.apps.api.viewsets.briefcase_viewset module

Module contents

The /briefcase API implementation.

class onadata.apps.api.viewsets.briefcase_viewset.BriefcaseViewset(**kwargs)

Bases: CreateModelMixin, RetrieveModelMixin, ListModelMixin, GenericViewSet

Implements the [Briefcase Aggregate API]( https://code.google.com/p/opendatakit/wiki/BriefcaseAggregateAPI).

authentication_classes = (<class 'onadata.libs.authentication.DigestAuthentication'>, <class 'rest_framework.authentication.TokenAuthentication'>)

create(request, *args, **kwargs)

Accepts an XForm XML and publishes it as a form.

filter_backends = (<class 'onadata.libs.filters.AnonDjangoObjectPermissionFilter'>,)

filter_queryset(queryset)

Filters an XForm submission instances using ODK Aggregate query parameters.

get_object(queryset=None)

Returns an Instance submission object for the given UUID.

list(request, *args, **kwargs)

Returns a list of submissions with reference submission download.

manifest(request, *args, **kwargs)

Returns list of media content.

media(request, *args, **kwargs)

Returns a single media content.

permission_classes = (<class 'rest_framework.permissions.IsAuthenticated'>, <class 'onadata.apps.api.permissions.ViewDjangoObjectPermissions'>)

queryset

renderer_classes = (<class 'onadata.libs.renderers.renderers.TemplateXMLRenderer'>, <class 'rest_framework.renderers.BrowsableAPIRenderer'>)

retrieve(request, *args, **kwargs)

Returns a single submission XML for download.

serializer_class

alias of XFormListSerializer

template_name = 'openrosa_response.xml'