SIC Clearing Day Calendar API V1 [CH]

HEAD Calendar in CSV Format

Clearing day calendar file in CSV format (only head, no content).

head

Query Parameters

calendarDaystring(date)

Calendar day (according to ISO 8601) that should be returned by the API call. If not specified all available, future entries are returned.

serviceIdentificationstring

Service identification that should be returned by the API call. If not specified all available services are returned.

Response

Content can be downloaded with GET method.

head/calendar.csv
 

healthcheck

System Healthcheck
This allows to check the basic state of the system (can it be reached, does it respond).

GET Health Check

Returns a status message of the system.

get

Response

application/json

Healthcheck successful

HealthCheckResponse

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

get/healthcheck
 
application/json

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
 

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