SIC Clearing Day Calendar API V1 [CH]

ClearingDayCalendarJsonResponseEntry

object

Contains clearing day information for a specific calendar date.

calendarDaystring(date)required

Calendar day (according to ISO 8601) of the record. All dependent information can be found as child elements.

Example:2024-12-23

dayOfWeekstringrequired

Day of week of the current record in english. This redundant information is only available to support readability.

>= 1 characters<= 15 characters

Example:Wednesday

servicesarray[object]required

Clearing day information for a specific service (e.g. SIC RTGS service or SIC IP service). This always includes the currently valid clearing day and may include planned downtimes and planned clearing day changes - if any.

Show Child Parameters
Example

Service

object

Clearing day information for a specific service (e.g. SIC RTGS service or SIC IP service). This always includes the currently valid clearing day and may include planned downtimes and planned clearing day changes - if any.

serviceIdentificationstringrequired

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

>= 1 characters<= 10 characters

Example:PCR_P

serviceDescriptionstringrequired

Additional information to the serviceIdentification. No predefined values.

>= 1 characters<= 250 characters

Example:SIC-RTGS-Service: External test environment for tests with production data and the current development status of the next release

clearingDaystring(date)required

The clearing day that is active on the start (00:00) of the related calendar day.

Example:2024-12-23

scheduledDowntimesarray[object]

A duration composed of start and end. The date-time fields are structured according to RFC3339, section 5.6 in ISO 8601 with timezone and milliseconds.

Show Child Parameters
scheduledClearingDayChangeobject

Used if a clearing day change is scheduled for the calendar date. Depending on the service certain child-elements are available:

a) clearing stops (SIC RTGS and euroSIC RTGS service)
b) cut-offs for euroSIC RTGS service
c) the next clearing day scheduled

The date-time fields are structured according to RFC3339, section 5.6 in ISO 8601 with timezone and milliseconds.

Show Child Parameters
Example

ScheduledClearingDayChange

object

Used if a clearing day change is scheduled for the calendar date. Depending on the service certain child-elements are available:

a) clearing stops (SIC RTGS and euroSIC RTGS service)
b) cut-offs for euroSIC RTGS service
c) the next clearing day scheduled

The date-time fields are structured according to RFC3339, section 5.6 in ISO 8601 with timezone and milliseconds.

scheduledClearingStop1string(date-time)

Clearing stop 1 date and time.

Example:2024-12-23T17:00:00+01:00

scheduledClearingStop2string(date-time)

Clearing stop 2 date and time.

Example:2024-12-23T18:00:00+01:00

scheduledClearingStop3string(date-time)

Clearing stop 3 date and time.

Example:2024-12-23T18:15:00+01:00

scheduledCutOff1string(date-time)

Cut off 1 date and time.

Example:2024-12-23T16:30:00+01:00

scheduledCutOff2string(date-time)

Cut off 2 date and time.

Example:2024-12-23T17:30:00+01:00

nextClearingDaystring(date)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

Example

Duration

object

A duration composed of start and end. The date-time fields are structured according to RFC3339, section 5.6 in ISO 8601 with timezone and milliseconds.

startDateTimestring(date-time)required

Start date and time of the duration.

Example:2024-12-23T12:00:00+01:00

endDateTimestring(date-time)required

End date and time of the duration.

Example

Problem

object
typestring(uri)

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

titlestringrequired

A short, human readable summary of the problem type.

Example:Request parameter has missing or invalid values

statusinteger(int32)required

The HTTP status code generated by the origin server for this occurrence
of the problem.

>= 100< 600

Example:400

detailstringrequired

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.

instancestring(uri)

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

metadataobject

Structured type that contains an object and its type.

Example:When associated with a 'Problem', it typically contains values which caused the failure and similar. May not contain sensitive CID.

Show Child Parameters
Example