Search
K
SIC Clearing Day Calendar API V1 [CH]

HEAD Health Check

Returns a status message of the system (only head, no content).

head

Response

Content can be downloaded with GET method.

head/healthcheck
  
curl --request HEAD \
  --url https://api.six-group.com/api/epcd/clearingday/v1/healthcheck \
  --header 'Content-Type: application/json'
Content can be downloaded with GET method.

ClearingDayCalendarJsonResponse

object

Toplevel element that contains metadata and clearing day calendar entries.

metaDataobjectrequired

Information about the validity and creation stamp.

Show Child Parameters
entriesarray[object]required

Contains clearing day information for a specific calendar date.

Show Child Parameters
Example
{
  "metaData": {
    "createdStamp": "2024-12-21T10:52:05.1904957+01:00"
  },
  "entries": [
    {
      "calendarDay": "2024-12-23",
      "dayOfWeek": "Wednesday",
      "services": [
        {
          "serviceIdentification": "PCR_P",
          "serviceDescription": "SIC-RTGS-Service: External test environment for tests with production data and the current development status of the next release",
          "clearingDay": "2024-12-23",
          "scheduledDowntimes": [
            {
              "startDateTime": "2024-12-23T12:00:00+01:00",
              "endDateTime": "endDateTime"
            }
          ],
          "scheduledClearingDayChange": {
            "scheduledClearingStop1": "2024-12-23T17:00:00+01:00",
            "scheduledClearingStop2": "2024-12-23T18:00:00+01:00",
            "scheduledClearingStop3": "2024-12-23T18:15:00+01:00",
            "scheduledCutOff1": "2024-12-23T16:30:00+01:00",
            "scheduledCutOff2": "2024-12-23T17:30:00+01:00",
            "nextClearingDay": "2024-12-24"
          }
        }
      ]
    }
  ]
}

ClearingDayCalendarMetaData

object

Information about the validity and creation stamp.

createdStampstring(date-time)required

Date and time (according to ISO 8601) at which this response was created.

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

Example
{
  "createdStamp": "2024-12-21T10:52:05.1904957+01:00"
}

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
{
  "calendarDay": "2024-12-23",
  "dayOfWeek": "Wednesday",
  "services": [
    {
      "serviceIdentification": "PCR_P",
      "serviceDescription": "SIC-RTGS-Service: External test environment for tests with production data and the current development status of the next release",
      "clearingDay": "2024-12-23",
      "scheduledDowntimes": [
        {
          "startDateTime": "2024-12-23T12:00:00+01:00",
          "endDateTime": "endDateTime"
        }
      ],
      "scheduledClearingDayChange": {
        "scheduledClearingStop1": "2024-12-23T17:00:00+01:00",
        "scheduledClearingStop2": "2024-12-23T18:00:00+01:00",
        "scheduledClearingStop3": "2024-12-23T18:15:00+01:00",
        "scheduledCutOff1": "2024-12-23T16:30:00+01:00",
        "scheduledCutOff2": "2024-12-23T17:30:00+01:00",
        "nextClearingDay": "2024-12-24"
      }
    }
  ]
}

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
{
  "serviceIdentification": "PCR_P",
  "serviceDescription": "SIC-RTGS-Service: External test environment for tests with production data and the current development status of the next release",
  "clearingDay": "2024-12-23",
  "scheduledDowntimes": [
    {
      "startDateTime": "2024-12-23T12:00:00+01:00",
      "endDateTime": "endDateTime"
    }
  ],
  "scheduledClearingDayChange": {
    "scheduledClearingStop1": "2024-12-23T17:00:00+01:00",
    "scheduledClearingStop2": "2024-12-23T18:00:00+01:00",
    "scheduledClearingStop3": "2024-12-23T18:15:00+01:00",
    "scheduledCutOff1": "2024-12-23T16:30:00+01:00",
    "scheduledCutOff2": "2024-12-23T17:30:00+01:00",
    "nextClearingDay": "2024-12-24"
  }
}