Fs Common Errors

Common HTTP Response Status Codes are used. The response body for all error responses are in the same format as below which includes the error code and message.

Example error response:

    {
        "code": "FS_1001",
        "detail": "Invalid request payload",
        "errors": [
            {
                "field": "<field_name>",
                "message": "Field required"
            }
        ],
        "title": "BAD_REQUEST",
        "type": "API_ERROR"
    }

Field Definitions

- title: This is a short, human-readable summary of the problem. It provides a brief title for the error reported.

- code: This is a unique identifier for this particular occurrence of the problem. It’s used to represent specific error types.

- detail: This is a human-readable explanation specific to this occurrence of the problem. It provides more details about the error.

- type: This is used to categorize the error. It helps in understanding the nature or category of the error. Common error types are API_ERROR and SERVICE_ERROR

• API_ERROR: These are errors that occur during the processing of API requests. They could be due to invalid input, authentication failures, authorization failures, etc. They are usually related to the interaction between the client and the API.
• SERVICE_ERROR: These are errors that occur within the internal services that the API depends on. For example, if your API depends on a database service and that service fails, it could result in a “SERVICE_ERROR”. These errors are usually related to the interaction between the API and its dependencies.

- errors: This is a list of additional error details. It’s used to provide more specific details about the error, especially when multiple errors have occurred.