SIC Service Status API V2 (XCR_E) [CH - QA]
ServiceStatusResponseEntry
objectStatus data for one service.
serviceIdentificationstringrequired
Values for Production Services: PCI_P
Values for Test environments:
- SIC IP service: XCI_E; ACI_E; XCI_P; ACI_P; VCI_E; VCI_P
>= 1 characters<= 10 characters
Example:PCI_P
statusstringrequired
Status information for the service is either UP or DOWN.
Allowed values:UPDOWN
Example:UP
timestampstring(date-time)required
Date and time (according to ISO 8601) at which this status data was last checked.
Example:2024-12-21T10:52:05.1904957+01:00
clearingDaystring(date)required
The current clearing day of this service.
Example:2024-12-21
businessVersionsarray[string]required
The business versions currently valid for this service.
Example:5.2, 5.3
clearingStatestringrequired
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:CLEARING_NORMAL
generalStopStatusstringrequired
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:INACTIVE
lastClearingStateChangestring(date-time)
Date and time (according to ISO 8601) at which the clearing state last changed to its current value
(see ‘clearingState’). Always omitted for the ip service, which does not support distinct clearing day phases.
Example:2024-12-21T06:00:00+01:00
Example
Status
stringStatus information for the service is either UP or DOWN.
Allowed values:UPDOWN
Example
ClearingState
stringRepresents 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
stringWhether 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
objectmessagestringrequired
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