magpie.api.requests

Module Contents

magpie.api.requests.get_request_method_content(request)

magpie.api.requests.get_multiformat_any(request, key, default=None) → Any

Obtains the key element from the request body using found Content-Type header.

magpie.api.requests.get_multiformat_post(request, key, default=None)

magpie.api.requests.get_multiformat_put(request, key, default=None)

magpie.api.requests.get_multiformat_delete(request, key, default=None)

magpie.api.requests.get_permission_multiformat_post_checked(request, service_or_resource, permission_name_key='permission_name') → Permission

Retrieves the permission from the body and validates that it is allowed for the specified service or resource.

magpie.api.requests.get_value_multiformat_post_checked(request, key, default=None)

magpie.api.requests.get_user(request, user_name_or_token=None) → models.User

magpie.api.requests.get_user_matchdict_checked_or_logged(request, user_name_key='user_name')

magpie.api.requests.get_user_matchdict_checked(request, user_name_key='user_name')

magpie.api.requests.get_group_matchdict_checked(request, group_name_key='group_name')

magpie.api.requests.get_resource_matchdict_checked(request, resource_name_key='resource_id') → models.Resource

magpie.api.requests.get_service_matchdict_checked(request, service_name_key='service_name')

magpie.api.requests.get_permission_matchdict_checked(request, service_or_resource, permission_name_key='permission_name') → Permission

Obtains the permission specified in the request path and validates that it is allowed for the specified service_or_resource which can be a service or a children resource.

Allowed permissions correspond to the direct service permissions or restrained permissions of the resource under its root service.

Returns:found permission name if valid for the service/resource

magpie.api.requests.get_value_matchdict_checked(request, key)

magpie.api.requests.get_query_param(request, case_insensitive_key, default=None) → Any

Retrieves a query string value by name (case insensitive), or returns the default if not present.