Api Error
=========

.. _ApiErrorDetails :

ApiErrorDetails
---------------

An object containing the Api Error Api error details.

.. code-block:: json

 message ApiErrorDetails {
  optional string field = 1;
  string code = 2;
  map<string, string> args = 3;
 }

.. list-table::
   :widths: 20 25 55
   :header-rows: 1

   * - Field
     - Type
     - Description
   * - ``field``
     - ``string``
     - **Optional.** 
   * - ``code``
     - ``string``
     - **Required.** 200, 400, 500, etc.
   * - ``args``
     - ``map<string, string>``
     - **Required.** 

.. _ApiError :

ApiError
--------

This is the record returned when an API-Error occurs

.. code-block:: json

 message ApiError {
  repeated ApiErrorDetails errors = 1;
 }

.. list-table::
   :widths: 20 25 55
   :header-rows: 1

   * - Field
     - Type
     - Description
   * - ``errors``
     - :ref:`ApiErrorDetails <ApiErrorDetails>`
     - **Required.** Repeated.