Clearing Day Calendar v1

metaData
required

ClearingDayCalendarMetaData

entries
required

< ClearingDayCalendarJsonResponseEntry > array

createdStamp
required

Date and time (according to ISO 8601) at which this response was created.
Example : "2024-12-21T10:52:05.1904957+01:00"

string (date-time)

calendarDay
required

Calendar day (according to ISO 8601) of the record. All dependent information can be found as child elements.
Example : "2024-12-23"

string (date)

dayOfWeek
required

Day of week of the current record in english. This redundant information is only available to support readability.
Length : 1 - 15
Example : "Wednesday"

string

services
required

< Service > array

serviceIdentification
required

Values for Production Services: PCR_P; PER_P; PCI_P
Values for Test environments:
- SIC RTGS service: XCR_E; XCR_P; ACR_E; ACR_P
- SIC IP service: XCI_E; ACI_E; XCI_P; ACI_P; VCI_E; VCI_P
- euroSIC RTGS service: XER_E; XER_P; AER_E; AER_P
Length : 1 - 10
Example : "PCR_P"

string

serviceDescription
required

Additional information to the serviceIdentification. No predefined values.
Length : 1 - 250
Example : "SIC-RTGS-Service: External test environment for tests with production data and the current development status of the next release"

string

clearingDay
required

The clearing day that is active on the start (00:00) of the related calendar day.
Example : "2024-12-23"

string (date)

scheduledDowntimes
optional

Planned downtime(s) of the service on this calendar day. If a downtime does not end by midnight, the end is 24:00 and the downtime continues at 00:00 on the next calendar day.

< Duration > array

scheduledClearingDayChange
optional

ScheduledClearingDayChange

scheduledClearingStop1
optional

Clearing stop 1 date and time.
Example : "2024-12-23T17:00:00.0000000+01:00"

string (date-time)

scheduledClearingStop2
optional

Clearing stop 2 date and time.
Example : "2024-12-23T18:00:00.0000000+01:00"

string (date-time)

scheduledClearingStop3
optional

Clearing stop 3 date and time.
Example : "2024-12-23T18:15:00.0000000+01:00"

string (date-time)

scheduledCutOff1
optional

Cut off 1 date and time.
Example : "2024-12-23T16:30:00.0000000+01:00"

string (date-time)

scheduledCutOff2
optional

Cut off 2 date and time.
Example : "2024-12-23T17:30:00.0000000+01:00"

string (date-time)

nextClearingDay
required

The clearing day that starts after day end processing (SIC and euroSIC RTGS service) or after day change (SIC IP service).
Example : "2024-12-24"

string (date)

startDateTime
required

Start date and time of the duration.
Example : "2024-12-23T12:00:00.0000000+01:00"

string (date-time)

endDateTime
required

End date and time of the duration.
Example : "2024-12-23T24:00:00.0000000+01:00"

string (date-time)

type
optional

An absolute URI that identifies the problem type.
We may provide human-readable documentation for the problem type in the future, when the URI is dereferenced.
Default : "about:blank"
Example : "/problems/REQUEST_PARAMETER_VALIDATION_FAILED"

string (uri)

title
required

A short, human readable summary of the problem type.
Example : "Request parameter has missing or invalid values"

string

status
required

The HTTP status code generated by the origin server for this occurrence
of the problem.
Minimum value : 100
Maximum value (exclusive) : 600
Example : 400

integer (int32)

detail
required

A human readable explanation specific to this occurrence of the
problem.
Example : "The submitted request contains invalid or missing request parameters which cannot be processed."

string

instance
optional

An absolute URI that identifies the specific occurrence of the problem.
It may or may not yield further information if dereferenced.
Example : "/api/epcd/bankmaster/v3/public/errors/EPCD0090000001/provided-D"

string (uri)

metadata
optional

GenericObject

@type
required

The field "@type" contains a URI/name identifying the type. Example: "@type": "types.example.com/standard/id".

string

data
required

An object of type @type containing custom fields.

object

message
required

Response message from health check.
Maximal length : 100
Example : "The health check GET request was successfully received and processed."

string

requestDateTime
required

According to RFC3339, section 5.6 in ISO 8601 with timezone and milliseconds.
Example : "2024-12-21T10:52:05.1904957+01:00"

string (date-time)

receivedHeaders
required

< receivedHeaders > array

environmentStage
required

The instance to which the request was sent to.
Example : "X1"

string

applicationVersion
required

The version of the API backend.
Example : "4.5.0-julia"

string

apiVersion
required

The version of the API.
Example : "1.0.23"

string

headerName
optional

The name of the provided header.
Example : "Accept"

string

headerValue
optional

As received
Example : "application/json"

string