rest_framework.exceptions.APIException

exception documentation

class APIException(Exception): (source)

Known subclasses: rest_framework.exceptions.AuthenticationFailed, rest_framework.exceptions.MethodNotAllowed, rest_framework.exceptions.NotAcceptable, rest_framework.exceptions.NotAuthenticated, rest_framework.exceptions.NotFound, rest_framework.exceptions.ParseError, rest_framework.exceptions.PermissionDenied, rest_framework.exceptions.Throttled, rest_framework.exceptions.UnsupportedMediaType, rest_framework.exceptions.ValidationError

View In Hierarchy

Base class for REST framework exceptions. Subclasses should provide `.status_code` and `.default_detail` properties.

Method __init__ Undocumented
Method __str__ Undocumented
Method get_codes Return only the code part of the error details.
Method get_full_details Return both the message & code parts of the error details.
Class Variable default_code Undocumented
Class Variable default_detail Undocumented
Instance Variable detail Undocumented
def __init__(self, detail=None, code=None): (source)
overridden in rest_framework.exceptions.MethodNotAllowed, rest_framework.exceptions.NotAcceptable, rest_framework.exceptions.Throttled, rest_framework.exceptions.UnsupportedMediaType, rest_framework.exceptions.ValidationError

Undocumented

def __str__(self): (source)

Undocumented

def get_codes(self): (source)

Return only the code part of the error details. Eg. {"name": ["required"]}

def get_full_details(self): (source)

Return both the message & code parts of the error details. Eg. {"name": [{"message": "This field is required.", "code": "required"}]}

default_code: str = (source)
overridden in rest_framework.exceptions.AuthenticationFailed, rest_framework.exceptions.MethodNotAllowed, rest_framework.exceptions.NotAcceptable, rest_framework.exceptions.NotAuthenticated, rest_framework.exceptions.NotFound, rest_framework.exceptions.ParseError, rest_framework.exceptions.PermissionDenied, rest_framework.exceptions.Throttled, rest_framework.exceptions.UnsupportedMediaType, rest_framework.exceptions.ValidationError

Undocumented

default_detail = (source)
overridden in rest_framework.exceptions.AuthenticationFailed, rest_framework.exceptions.MethodNotAllowed, rest_framework.exceptions.NotAcceptable, rest_framework.exceptions.NotAuthenticated, rest_framework.exceptions.NotFound, rest_framework.exceptions.ParseError, rest_framework.exceptions.PermissionDenied, rest_framework.exceptions.Throttled, rest_framework.exceptions.UnsupportedMediaType, rest_framework.exceptions.ValidationError

Undocumented

detail = (source)
overridden in rest_framework.exceptions.ValidationError

Undocumented