SIC Clearing Day Calendar API V1 [CH]

GET Calendar in JSON Format

Returns the clearing day calendar data as a JSON object.

get

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

application/json

Clearing day calendar in JSON format

ClearingDayCalendarJsonResponse

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
get/calendar
 
application/json

HEAD Calendar in JSON Format

Clearing day calendar file in JSON 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
 

GET Calendar File in CSV Format

Clearing day calendar file in CSV format, with header row. The file encoding corresponds to the Unicode character set UTF-8 and must be read accordingly (umlauts, etc.).

get

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

Clearing day calendar file in CSV format.

get/calendar.csv
 

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).