Module macrobond_data_api.web.web_types.problem_details_exception

Browse git

Classes

class ProblemDetailsException (response: Response, title: str = None, status: int = None, detail: str = None, instance: str = None, extensions: Dict[str, Optional[Any]] = None, errors: Dict[str, List[str]] = None)

A machine-readable format for specifying errors in HTTP API responses based on https://tools.ietf.org/html/rfc7807.

Browse git

Ancestors

  • builtins.Exception
  • builtins.BaseException

Class variables

var response : Response

Static methods

def create_from_response(response: Response) ‑> ProblemDetailsException
Browse git

Instance variables

var detail : Optional[str]

A human-readable explanation specific to this occurrence of the problem.

var errors

Gets the validation errors associated with this instance

var extensions : Optional[Dict[str, Optional[Any]]]

Summary: Gets the Optional[Dict[str, Optional[Any]]] for extension members. Problem type definitions MAY extend the problem details object with additional members. Extension members appear in the same namespace as other members of a problem type.

Remarks: The round-tripping behavior for Microsoft.AspNetCore.Mvc.ProblemDetails.Extensions is determined by the implementation of the Input \ Output formatters. In particular, complex types or collection types may not round-trip to the original type when using the built-in JSON or XML formatters.

var instance : Optional[str]

A URI reference that identifies the specific occurrence of the problem.It may or may not yield further information if dereferenced.

var status : Optional[int]

The HTTP status code([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.

var title : Optional[str]

A short, human-readable summary of the problem type.It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization(e.g., using proactive content negotiation; see[RFC7231], Section 3.4).

var type : Optional[str]

A URI reference [RFC3986] that identifies the problem type. This specification encourages that, when dereferenced, it provide human-readable documentation for the problem type (e.g., using HTML [W3C.REC-html5-20141028]). When this member is not present, its value is assumed to be "about:blank".