# eBill platform health check

Returns a status message of the eBill system managed by SIX

Endpoint: GET /api/v1/healthcheck/ebill
Version: 1.1
Security: X-API-Key

## Response 200 fields (application/json):

  - `message` (string, required)
    response message from health check
    Example: "The healthcheck GET request was successfully received and processed"

  - `requestDateTime` (string, required)
    according to RFC3339, section 5.6 in ISO 8601 with timezone and milliseconds
    Example: "2018-10-03T16:03:09.101+02:00"

  - `receivedHeaders` (array, required)

  - `receivedHeaders.headerName` (string)
    the name of the provided header
    Example: "x-correlation-id"

  - `receivedHeaders.headerValue` (string)
    As received
    Example: "9bcd4351-4b7b-4017-9b63-9613414c6ff1"

  - `environmentStage` (string, required)
    the instance which the request was sent to
    Example: "XE"

  - `applicationVersion` (string, required)
    the version of the eBill infrastructure
    Example: "1.4.3.0-desire-20180927091004161-71-5e3ca91"

  - `apiVersion` (string, required)
    the version of the network partner api
    Example: "1.0.23"

  - `maintenanceWindows` (array)
    Information about the upcoming maintenance windows. If no maintenance is planned, an empty list is returned.

  - `maintenanceWindows.start` (string, required)
    start time of the maintenance window
    Example: "2021-01-01T10:00Z"

  - `maintenanceWindows.end` (string, required)
    end time of the maintenance window
    Example: "2021-01-01T14:00Z"

## Response 400 fields (application/json):

  - `status` (integer)
    The HTTP status code generated by the origin server for this occurrence of the problem.
    Example: 400

  - `message` (string)
    A human readable explanation specific to this occurrence of the problem.
    Example: "The submitted request contains invalid or missing data which can not be processed."

  - `fieldErrors` (array)

  - `fieldErrors.fieldName` (string)
    the name of the field with the error
    Example: "localizedData.ger.address.city"

  - `fieldErrors.message` (string)
    the message describing the error
    Example: "size must be between 1 and 35"

  - `fieldErrors.rejectedValue` (string)
    the provided value which was rejected if available
    Example: "Very Long Invalid City Name Which Is Rejected"