ClearingState

string

Represents the current clearing state.
The ip service does not support distinct clearing day phases and therefore always reports CLEARING_NORMAL.
UNKNOWN is reported if this could not be determined.

Allowed values:READY_FOR_CLEARINGCLEARING_NORMALCLEARING_STOP_1CLEARING_STOP_2CLEARING_STOP_3UNKNOWN

Example

GeneralStopStatus

string

Whether a general stop is currently in effect for the service, and which kind. INACTIVE means no general
stop is in effect. UNKNOWN is reported if this could not be determined.

Allowed values:INACTIVEGENERAL_SETTLEMENT_STOPGENERAL_SERVICE_STOPUNKNOWN

Example

HealthCheckResponse

object
messagestringrequired

Response message from health check.

<= 100 characters

Example:The health check GET request was successfully received and processed.

requestDateTimestring(date-time)required

According to RFC3339, section 5.6 in ISO 8601 with timezone and milliseconds.

Example:2024-12-21T10:52:05.1904957+01:00

receivedHeadersarray[object]required
Show Child Parameters
environmentStagestringrequired

The instance to which the request was sent to.

Example:X1

applicationVersionstringrequired

The version of the API backend.

Example:4.5.0-julia

apiVersionstringrequired

The version of the API.

Example:1.0.23

Example