The error response
==================

The error response contains ``error`` and ``request`` parts.
In debug mode we add another ``symfony`` part and more global information.

Attributes
----------

* ``error.code`` integer

A code to represent the error.

* ``error.message`` string

An error description.

* ``error.locale`` string

The locale of the error message.

* ``error.context`` array

An additional set of data related to the error.

* ``error.statusCode`` integer

The HTTP error status code.

* ``error.violations`` object

An optional entry added in case or data received are not valid (corresponding to error code 1).

* ``request.method`` string

The HTTP request method.

* ``request.url`` string

The requested url.

* ``request.queryParams`` object

An object with query parameters received.

* ``request.requestParams`` object

An object with request parameters received.

Example
"""""""

.. code-block:: json

    {
        "error": {
            "code": 1,
            "message": "Validation error",
            "locale": "en",
            "context": [],
            "statusCode": 400,
            "violations": {
                "name": [
                    "This value should not be blank."
                ]
            }
        },
        "request": {
            "method": "POST",
            "url": "https://app.yumisign.com/api/v1/examples",
            "queryParams": {},
            "requestParams": {}
        }
    }