.. This work is licensed under a Creative Commons Attribution 4.0 International License.


Offered APIs
=================

+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Entity              | Method   | Path Info                                             | Description                                                                                                                                                                               |
+=====================+==========+=======================================================+===========================================================================================================================================================================================+
| Health Check        | GET      | /healthCheck                                          | The Health Status of the application checks the DB connection.                                                                                                                            |
+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|                     |          |                                                       | Used by IDNS for redundancy                                                                                                                                                               |
+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|                     |          |                                                       |                                                                                                                                                                                           |
+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|                     |          |                                                       | return response entity:                                                                                                                                                                   |
+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|                     |          |                                                       | - statusCode Either 200 or 500                                                                                                                                                            |
+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|                     |          |                                                       | - The message contains additional detail in the case of an error, and is empty in the case of success.                                                                                    |
+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|                     |          |                                                       |                                                                                                                                                                                           |
+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|                     |          |                                                       | Expected:                                                                                                                                                                                 |
+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|                     |          |                                                       | {                                                                                                                                                                                         |
+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|                     |          |                                                       | “statusCode”:200,                                                                                                                                                                         |
+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|                     |          |                                                       | “message”:“health check succeeded”,                                                                                                                                                       |
+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|                     |          |                                                       | “date”:null                                                                                                                                                                               |
+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|                     |          |                                                       | }                                                                                                                                                                                         |
+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|                     |          |                                                       |                                                                                                                                                                                           |
+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+