Search Calendar

Overview

GET /rest/calendar/search

This endpoint is used to search existing calendars.

Required Permissions

Users can search existing calendars.

Request

XML

GET <service_url>/rest/calendar/search

Parameters

Parameter	Type	Description	Required
name	String	The name of the calendar to search for.	No
searchType	String	The type of search to perform. Can only be "exact" or "contain".	No
pageNumber	Integer	The page number of the paginated results.	No
maxResults	Integer	The maximum number of results is 100. Default value is 10.	No

Example Requests

CODE

GET https://tis.obss.io/rest/calendar/search?name=Example&searchType=exact

GET https://tis.obss.io/rest/calendar/search?name=Example&searchType=contain

GET https://tis.obss.io/rest/calendar/search?name=&searchType=exact

GET https://tis.obss.io/rest/calendar/search?name=Example&searchType=contain&pageNumber=0&maxResults=50

Response

Response Structure

CODE

{
  "id": Integer, // The unique identifier of the calendar
  "name": String, // The name of the calendar
  "clientKey": String, // The client key associated with the calendar
  "isDefault": Boolean, // Indicates if this is the default calendar
  "is7x24Calendar": Boolean, // Indicates if the calendar operates 24/7
  "allWorkingDaysHaveEqualLengths": Boolean, // Indicates if all working days have equal lengths
  "calendarSuccessfullyLoaded": Boolean, // Indicates if the calendar was successfully loaded
  "dailyWorkingHours": Double, // The number of working hours per day
  "timeZone": String, // The time zone of the calendar
  "workingTimes": [
    {
      "weekday": String, // The day of the week
      "start": Long, // The start time in milliseconds
      "end": Long // The end time in milliseconds
    }
  ],
  "holidays": [
    {
      "name": String, // The name of the holiday
      "date": String, // The date of the holiday
      "recurring": Boolean // Indicates if the holiday is recurring
    }
  ]
}

Example Response Body

JSON

{
  "pageNumber": 0,
  "pageSize": 50,
  "total": 1,
  "calendars": [
    {
      "clientKey": "ffa2107c-c816-3aa3-985a-0163faa27103",
      "id": 1,
      "isDefault": true,
      "name": "Default Calendar Settings",
      "timeZone": "Europe/Istanbul",
      "workingTimes": [
        {
          "weekday": "MONDAY",
          "start": 28800000,
          "end": 61500000
        },
        {
          "weekday": "MONDAY",
          "start": 75600000,
          "end": 78000000
        }
      ],
      "holidays": [
        {
          "name": "Holiday 1",
          "date": "2025-04-28",
          "recurring": true
        }
      ],
      "is7x24Calendar": false,
      "allWorkingDaysHaveEqualLengths": true,
      "calendarSuccessfullyLoaded": true,
      "dailyWorkingHours": 9.75
    }
  ],
  "last": true
}

Response Codes

200 OK: Returns a paginated list of calendars matching the search criteria.
400 Bad Request: If the request parameters are invalid.