onadata.apps.api.viewsets.xform_list_viewset module

Module contents

OpenRosa Form List API - https://docs.getodk.org/openrosa-form-list/

class onadata.apps.api.viewsets.xform_list_viewset.PreviewXFormListViewSet(**kwargs)

Bases: XFormListViewSet

OpenRosa Form List API - for preview purposes only

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

permission_classes = (<class 'rest_framework.permissions.AllowAny'>,)

class onadata.apps.api.viewsets.xform_list_viewset.XFormListViewSet(**kwargs)

Bases: ETagsMixin, DefaultBaseViewset, ReadOnlyModelViewSet

OpenRosa Form List API - https://docs.getodk.org/openrosa-form-list/

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

content_negotiation_class

alias of MediaFileContentNegotiation

filter_backends = (<class 'onadata.libs.filters.XFormListObjectPermissionFilter'>, <class 'onadata.libs.filters.XFormListXFormPKFilter'>, <class 'django_filters.rest_framework.backends.DjangoFilterBackend'>)

filter_queryset(queryset)

Given a queryset, filter it with whichever filter backend is in use.

You are unlikely to want to override this method, although you may need to call it either from a list view, or from a custom get_object method if you want to apply the configured filtering backend to the default queryset.

filterset_class

alias of FormIDFilter

get_object()

Returns the object the view is displaying.

You may want to override this if you need to provide non-standard queryset lookups. Eg if objects are referenced using multiple keyword arguments in the url conf.

get_serializer(*args, **kwargs)

Return the serializer instance that should be used for validating and deserializing input, and for serializing output.

get_serializer_class()

Return the class to use for the serializer

list(request, *args, **kwargs)

manifest(request, *args, **kwargs)

A manifest defining additional supporting objects.

media(request, *args, **kwargs)

Returns the media file contents.

permission_classes = (<class 'rest_framework.permissions.AllowAny'>,)

queryset

renderer_classes = (<class 'onadata.libs.renderers.renderers.XFormListRenderer'>,)

retrieve(request, *args, **kwargs)

serializer_class

alias of XFormListSerializer

template_name = 'api/xformsList.xml'

throttle_scope = 'xformlist'