Skip to content

responses

DataResponse

Bases: GeneralResponse

Represents a response containing general data, inheriting from the GeneralResponse.

This class is used for defining a response structure that includes the general data model. It enforces the inclusion of the general data field, ensuring proper structure and expected data handling as part of the response. It can be extended or utilized wherever a general data response entity is required.

Attributes:

Name Type Description
data GeneralDataModel

The general data model that represents the main content of the response.
Source code in backend/app/responses.py 
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
class DataResponse(GeneralResponse):
    """
    Represents a response containing general data, inheriting from the
    GeneralResponse.

    This class is used for defining a response structure that includes the
    general data model. It enforces the inclusion of the general data field,
    ensuring proper structure and expected data handling as part of the response.
    It can be extended or utilized wherever a general data response entity
    is required.

    :ivar data: The general data model that represents the main content of
                the response.
    :type data: GeneralDataModel
    """
    data: GeneralDataModel = Field(...)

ErrorResponse

Bases: GeneralResponse

Represents an error response detailing the result of a failed operation.

This class extends the GeneralResponse and is intended to provide a standard structure for reporting errors or unsuccessful operations in the application. It includes attributes that indicate the success status and any data related to the error response.

Attributes:

Name Type Description
data None

Data returned by the request. Default is None.
success bool

Indicates whether the request was successful or not. Default is False.
Source code in backend/app/responses.py 
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
class ErrorResponse(GeneralResponse):
    """
    Represents an error response detailing the result of a failed operation.

    This class extends the GeneralResponse and is intended to provide a standard
    structure for reporting errors or unsuccessful operations in the application.
    It includes attributes that indicate the success status and any data related
    to the error response.

    :ivar data: Data returned by the request. Default is None.
    :type data: None
    :ivar success: Indicates whether the request was successful or not. Default is False.
    :type success: bool
    """
    data: None = Field(
        default=None,
        description="Data returned by the request."
    )
    success: bool = Field(
        default=False,
        description="Indicates whether the request was successful or not."
    )

GeneralResponse

Bases: BaseModel

Represents the general response structure for API requests.

This class encapsulates the standard response format, including the data returned, success status, and any errors that occurred during the request. It is utilized as the base model for structuring API responses.

Attributes:

Name Type Description
data None

Data returned by the request.
success bool

Indicates whether the request was successful or not.
errors list[ErrorModel] | None

List of errors encountered during the request.
Source code in backend/app/responses.py 
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
class GeneralResponse(BaseModel):
    """
    Represents the general response structure for API requests.

    This class encapsulates the standard response format, including the data
    returned, success status, and any errors that occurred during the request.
    It is utilized as the base model for structuring API responses.

    :ivar data: Data returned by the request.
    :type data: None
    :ivar success: Indicates whether the request was successful or not.
    :type success: bool
    :ivar errors: List of errors encountered during the request.
    :type errors: list[ErrorModel] | None
    """
    data: None = Field(
        default=None,
        description="Data returned by the request."
    )
    success: bool = Field(
        default=True,
        description="Indicates whether the request was successful or not."
    )
    errors: list[ErrorModel] | None = Field(
        default=None,
        description="List of errors encountered during the request."
    )

MessageResponse

Bases: GeneralResponse

Represents a response message inheriting properties from GeneralResponse.

This class is used to handle message responses with associated data and extends the general response functionality by including a specific 'data' attribute.

Attributes:

Name Type Description
data str

The content of the response message.
Source code in backend/app/responses.py 
55
56
57
58
59
60
61
62
63
64
65
class MessageResponse(GeneralResponse):
    """
    Represents a response message inheriting properties from `GeneralResponse`.

    This class is used to handle message responses with associated data and extends
    the general response functionality by including a specific 'data' attribute.

    :ivar data: The content of the response message.
    :type data: str
    """
    data: str = Field(...)

ResultResponse

Bases: GeneralResponse

Represents a response containing result data, inheriting from GeneralResponse.

This class is used to encapsulate response data specific to result information. It extends the functionality provided by GeneralResponse and includes additional data fields related to results. The purpose of this class is to standardize the structure of result-related responses and ensure consistent access to result data in the response object.

Attributes:

Name Type Description
data ResultDataModel

Contains the specific result data encapsulated in the ResultDataModel.
Source code in backend/app/responses.py 
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
class ResultResponse(GeneralResponse):
    """
    Represents a response containing result data, inheriting from GeneralResponse.

    This class is used to encapsulate response data specific to result information.
    It extends the functionality provided by GeneralResponse and includes additional
    data fields related to results. The purpose of this class is to standardize the
    structure of result-related responses and ensure consistent access to result
    data in the response object.

    :ivar data: Contains the specific result data encapsulated in the ResultDataModel.
    :type data: ResultDataModel
    """
    data: ResultDataModel