Calendars

Overview

GET /rest/calendar

A list of calendars defined in the system with their IDs can be requested through the following REST endpoint.

Required Permissions

All Users with Timepiece access can retrieve a list of calendars defined in the system with their IDs can be requested through the following REST endpoint.

Request

CODE

GET <service_url>/rest/calendar

Parameters

This request requires no parameters.

Example Requests

CODE

GET https://tis.obss.io/rest/calendar

Response

Example Response Body

JSON

[
    {
        "allWorkingDaysHaveEqualLengths": true,
        "calendarSuccessfullyLoaded": true,
        "clientKey": null,
        "dailyWorkingHours": 24.0,
        "holidays": [],
        "id": null,
        "is7x24Calendar": true,
        "isDefault": null,
        "name": "normalHours",
        "timeZone": "UTC",
        "workingTimes": [
            {
                "end": 86400000,
                "start": 0,
                "weekday": "SUNDAY"
            },
            {
                "end": 86400000,
                "start": 0,
                "weekday": "MONDAY"
            },
            {
                "end": 86400000,
                "start": 0,
                "weekday": "TUESDAY"
            },
            {
                "end": 86400000,
                "start": 0,
                "weekday": "WEDNESDAY"
            },
            {
                "end": 86400000,
                "start": 0,
                "weekday": "THURSDAY"
            },
            {
                "end": 86400000,
                "start": 0,
                "weekday": "FRIDAY"
            },
            {
                "end": 86400000,
                "start": 0,
                "weekday": "SATURDAY"
            }
        ]
    },
    {
        "allWorkingDaysHaveEqualLengths": true,
        "calendarSuccessfullyLoaded": true,
        "clientKey": "c0b91cc2-61aa-35f7-ac4f-b799fc933343",
        "dailyWorkingHours": 9.0,
        "holidays": [],
        "id": 147,
        "is7x24Calendar": false,
        "isDefault": true,
        "name": "Default Calendar Settings",
        "timeZone": "UTC",
        "workingTimes": [
            {
                "end": 61200000,
                "start": 28800000,
                "weekday": "MONDAY"
            },
            {
                "end": 61200000,
                "start": 28800000,
                "weekday": "TUESDAY"
            },
            {
                "end": 61200000,
                "start": 28800000,
                "weekday": "WEDNESDAY"
            },
            {
                "end": 61200000,
                "start": 28800000,
                "weekday": "THURSDAY"
            },
            {
                "end": 61200000,
                "start": 28800000,
                "weekday": "FRIDAY"
            }
        ]
    },
    {
        "allWorkingDaysHaveEqualLengths": true,
        "calendarSuccessfullyLoaded": true,
        "clientKey": "c0b91cc2-61aa-35f7-ac4f-b799fc933343",
        "dailyWorkingHours": 8.0,
        "holidays": [],
        "id": 150,
        "is7x24Calendar": false,
        "isDefault": false,
        "name": "Two Shift Calendar",
        "timeZone": "Europe/Istanbul",
        "workingTimes": [
            {
                "end": 43200000,
                "start": 28800000,
                "weekday": "MONDAY"
            },
            {
                "end": 61200000,
                "start": 46800000,
                "weekday": "MONDAY"
            },
            {
                "end": 43200000,
                "start": 28800000,
                "weekday": "TUESDAY"
            },
            {
                "end": 61200000,
                "start": 46800000,
                "weekday": "TUESDAY"
            },
            {
                "end": 43200000,
                "start": 28800000,
                "weekday": "WEDNESDAY"
            },
            {
                "end": 61200000,
                "start": 46800000,
                "weekday": "WEDNESDAY"
            },
            {
                "end": 43200000,
                "start": 28800000,
                "weekday": "THURSDAY"
            },
            {
                "end": 61200000,
                "start": 46800000,
                "weekday": "THURSDAY"
            },
            {
                "end": 43200000,
                "start": 28800000,
                "weekday": "FRIDAY"
            },
            {
                "end": 61200000,
                "start": 46800000,
                "weekday": "FRIDAY"
            }
        ]
    },
    {
        "allWorkingDaysHaveEqualLengths": true,
        "calendarSuccessfullyLoaded": true,
        "clientKey": "c0b91cc2-61aa-35f7-ac4f-b799fc933343",
        "dailyWorkingHours": 11.0,
        "holidays": [],
        "id": 151,
        "is7x24Calendar": false,
        "isDefault": false,
        "name": "Three Shift Calendar",
        "timeZone": "Europe/Istanbul",
        "workingTimes": [
            {
                "end": 43200000,
                "start": 28800000,
                "weekday": "MONDAY"
            },
            {
                "end": 61200000,
                "start": 46800000,
                "weekday": "MONDAY"
            },
            {
                "end": 75600000,
                "start": 64800000,
                "weekday": "MONDAY"
            },
            {
                "end": 43200000,
                "start": 28800000,
                "weekday": "TUESDAY"
            },
            {
                "end": 61200000,
                "start": 46800000,
                "weekday": "TUESDAY"
            },
            {
                "end": 75600000,
                "start": 64800000,
                "weekday": "TUESDAY"
            },
            {
                "end": 43200000,
                "start": 28800000,
                "weekday": "WEDNESDAY"
            },
            {
                "end": 61200000,
                "start": 46800000,
                "weekday": "WEDNESDAY"
            },
            {
                "end": 75600000,
                "start": 64800000,
                "weekday": "WEDNESDAY"
            },
            {
                "end": 43200000,
                "start": 28800000,
                "weekday": "THURSDAY"
            },
            {
                "end": 61200000,
                "start": 46800000,
                "weekday": "THURSDAY"
            },
            {
                "end": 75600000,
                "start": 64800000,
                "weekday": "THURSDAY"
            },
            {
                "end": 43200000,
                "start": 28800000,
                "weekday": "FRIDAY"
            },
            {
                "end": 61200000,
                "start": 46800000,
                "weekday": "FRIDAY"
            },
            {
                "end": 75600000,
                "start": 64800000,
                "weekday": "FRIDAY"
            }
        ]
    },
    {
        "allWorkingDaysHaveEqualLengths": true,
        "calendarSuccessfullyLoaded": true,
        "clientKey": "c0b91cc2-61aa-35f7-ac4f-b799fc933343",
        "dailyWorkingHours": 4.0,
        "holidays": [],
        "id": 155,
        "is7x24Calendar": false,
        "isDefault": false,
        "name": "5/24 Calendar",
        "timeZone": "Europe/Istanbul",
        "workingTimes": [
            {
                "end": 43200000,
                "start": 28800000,
                "weekday": "MONDAY"
            },
            {
                "end": 43200000,
                "start": 28800000,
                "weekday": "TUESDAY"
            },
            {
                "end": 43200000,
                "start": 28800000,
                "weekday": "WEDNESDAY"
            },
            {
                "end": 43200000,
                "start": 28800000,
                "weekday": "THURSDAY"
            },
            {
                "end": 43200000,
                "start": 28800000,
                "weekday": "FRIDAY"
            }
        ]
    }
]

Response Codes

200 OK: Returns a JSON that contains all calendars defined in your instance, including the predefined 7/24 (normalHours) Calendar and Default Calendar Settings.