Получить основные настройки календаря calendar.settings.get

Выберите инструмент для разработки с AI-агентом:

  • используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
  • используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации

Scope: calendar

Кто может выполнять метод: любой пользователь

Метод получает основные настройки календаря. Изменить основные настройки может только администратор портала.

Без параметров.

Примеры кода

Как использовать примеры в документации

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/calendar.settings.get
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/calendar.settings.get
// This snippet is an ES module: top-level await requires type="module" or a bundler.
// $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame } from '@bitrix24/b24jssdk'

declare const $b24: B24Frame

// Shape of the payload returned in result (match the "response handling" section of the page)
type CalendarSettingsResult = {
  work_time_start: string
  work_time_end: string
  year_holidays: string
  year_workdays: string
  week_holidays: string[]
  week_start: string
  user_name_template: string
  sync_by_push: boolean
  user_show_login: boolean
  path_to_user: string
  path_to_user_calendar: string
  path_to_group: string
  path_to_group_calendar: string
  path_to_vr: string
  path_to_rm: string
  rm_iblock_type: string
  rm_iblock_id: string
  dep_manager_sub: boolean
  denied_superpose_types: string[]
  pathes_for_sites: string
  forum_id: string
  rm_for_sites: boolean
  path_to_type_company_calendar: string
  path_to_type_location: string
  path_to_type_open_event: string
}

try {
  const response = await $b24.actions.v2.call.make<CalendarSettingsResult>({
    method: 'calendar.settings.get',
    params: {},
    requestId: Text.getUuidRfc4122()
  })

  // The payload is available only on a successful response
  if (!response.isSuccess) {
    console.error(response.getErrorMessages().join('; '))
  } else {
    const result = response.getData()!.result
    console.info('Calendar settings:', result.work_time_start, result.work_time_end)
  }
} catch (error) {
  // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
  console.error(error)
}
<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
  async function getCalendarSettings() {
    try {
      // Initialize the SDK inside a Bitrix24 frame
      const $b24 = await B24Js.initializeB24Frame()

      const response = await $b24.actions.v2.call.make({
        method: 'calendar.settings.get',
        params: {},
        requestId: B24Js.Text.getUuidRfc4122()
      })

      // The payload is available only on a successful response
      if (!response.isSuccess) {
        console.error(response.getErrorMessages().join('; '))
        return
      }

      const result = response.getData().result
      console.info('Calendar settings:', result.work_time_start, result.work_time_end)
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

  document.addEventListener('DOMContentLoaded', getCalendarSettings)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException

try:
    bitrix_response = client.calendar.settings.get().response
    result = bitrix_response.result
    print(result)
except BitrixAPIError as error:
    print(
        "Ошибка Bitrix API",
        f"error: {error.error}",
        f"error_description: {error.error_description}",
        sep="\n",
    )
except BitrixSDKException as error:
    print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
    print(f"Непредвиденная ошибка: {error}")
try {
    $response = $b24Service
        ->core
        ->call(
            'calendar.settings.get',
            []
        );

    $result = $response
        ->getResponseData()
        ->getResult();

    echo 'Success: ' . print_r($result, true);
    // Нужная вам логика обработки данных
    processData($result);

} catch (Throwable $e) {
    error_log($e->getMessage());
    echo 'Error getting calendar settings: ' . $e->getMessage();
}
BX24.callMethod(
    'calendar.settings.get',
    {}
);
require_once('crest.php');

$result = CRest::call(
    'calendar.settings.get',
    []
);

echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "calendar.settings.get", nil, b24.WithIdempotent())
if err != nil {
	return fmt.Errorf("calendar.settings.get: %w", err)
}

var item struct {
	WorkTimeStart    string `json:"work_time_start"`
	WorkTimeEnd      string `json:"work_time_end"`
	YearHolidays     string `json:"year_holidays"`
	YearWorkdays     string `json:"year_workdays"`
	WeekStart        string `json:"week_start"`
	UserNameTemplate string `json:"user_name_template"`
}
if err := json.Unmarshal(res.Result, &item); err != nil {
	return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println(item.WorkTimeStart, item.WorkTimeEnd)

Обработка ответа

HTTP-статус: 200

{
    "result": {
        "work_time_start": "9",
        "work_time_end": "19",
        "year_holidays": "1.01,2.01,7.01,23.02,8.03,1.05,9.05,12.06,4.11",
        "year_workdays": "31.12",
        "week_holidays": [
            "SA",
            "SU"
        ],
        "week_start": "MO",
        "user_name_template": "#NAME# #LAST_NAME#",
        "sync_by_push": false,
        "user_show_login": true,
        "path_to_user": "/company/personal/user/#user_id#/",
        "path_to_user_calendar": "/company/personal/user/#user_id#/calendar/",
        "path_to_group": "/workgroups/group/#group_id#/",
        "path_to_group_calendar": "/workgroups/group/#group_id#/calendar/",
        "path_to_vr": "",
        "path_to_rm": "",
        "rm_iblock_type": "",
        "rm_iblock_id": "",
        "dep_manager_sub": true,
        "denied_superpose_types": [],
        "pathes_for_sites": "",
        "forum_id": "8",
        "rm_for_sites": true,
        "path_to_type_company_calendar": "",
        "path_to_type_location": "",
        "path_to_type_open_event": ""
    },
    "time": {
        "start": 1733924639.802569,
        "finish": 1733924640.184363,
        "duration": 0.3817939758300781,
        "processing": 0.012382984161376953,
        "date_start": "2024-12-11T13:43:59+00:00",
        "date_finish": "2024-12-11T13:44:00+00:00"
    }
}

Возвращаемые данные

Название
тип

Описание

result
object

Корневой элемент ответа

work_time_start
string

Время начала рабочего дня

work_time_end
string

Время окончания рабочего дня

year_holidays
string

Список праздничных дней

week_holidays
array

Массив выходных дней

week_start
string

День начала недели

user_name_template
string

Шаблон имени пользователя

sync_by_push
boolean

Флаг автоматической синхронизации календарей по подписке. Push-события от Google/Office365

user_show_login
boolean

Флаг отображения логина пользователя

path_to_user
string

Шаблон ссылки на профиль пользователя

path_to_user_calendar
string

Шаблон ссылки на просмотр календаря пользователя

path_to_group
string

Шаблон ссылки на просмотр рабочей группы

path_to_group_calendar
string

Шаблон ссылки на просмотр календаря группы

path_to_vr
string

Шаблон ссылки к видеопереговорной

path_to_rm
string

Шаблон ссылки к переговорной

rm_iblock_type
string

Тип инфоблока бронирования переговорных и видеопереговорных

rm_iblock_id
string

Идентификатор инфоблока бронирования переговорных

dep_manager_sub
boolean

Флаг разрешения начальникам просматривать календари подчиненных

denied_superpose_types
array

Список типов календарей, которые не могут быть добавлены в избранные

pathes_for_sites
boolean

Устанавливает шаблоны ссылок общие для всех сайтов

forum_id
string

Идентификатор форума для комментариев

rm_for_sites
boolean

Устанавливает параметры переговорных общие для всех сайтов

path_to_type_company_calendar
string

Шаблон ссылки на просмотр календарей компании

path_to_type_location
string

Шаблон ссылки на просмотр бронирования переговорных

path_to_type_open_event
string

Шаблон ссылки на просмотр календаря открытых событий

Обработка ошибок

Статусы и коды системных ошибок

HTTP-статус: 4xx, 5xx

Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.

Статус

Код
Текст ошибки

Описание

500

INTERNAL_SERVER_ERROR
Internal server error

Возникла внутренняя ошибка сервера. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

Сервер вернул неожиданный ответ. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24

503

QUERY_LIMIT_EXCEEDED
Too many requests

Превышен лимит на интенсивность запросов

429

OPERATION_TIME_LIMIT
Method is blocked due to operation time limit

Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически, когда накопленное время выполнения метода перестает превышать лимит

401

NO_AUTH_FOUND
Wrong authorization data

В запросе нет авторизационных данных: не передан ни access-токен, ни код вебхука

401

INVALID_REQUEST
Https required

Методы вызываются только по протоколу HTTPS

401

OVERLOAD_LIMIT
REST API is blocked due to overload

REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка. Чтобы ее снять, обратитесь в техническую поддержку Битрикс24

401

ACCESS_DENIED
REST is available only on commercial plans

REST API доступен только на коммерческих тарифах. У вебхука текст ошибки другой — REST is available only by subscription

401

INVALID_CREDENTIALS
Invalid request credentials

Не найден активный вебхук с указанным идентификатором пользователя и секретным кодом

404

ERROR_METHOD_NOT_FOUND
Method not found!

Метод с таким именем не найден. Имя написано с ошибкой, метода нет в REST API или он недоступен без нужного скоупа

401

insufficient_scope
The request requires higher privileges than provided by the webhook token

Запрос требует более широких прав, чем есть у токена: у вебхука это выданные ему права, у приложения — скоуп. У приложения текст ошибки заканчивается на provided by the access token

401

expired_token
The access token provided has expired

Срок действия access-токена истек

401

user_access_error
The user does not have access to the application

Приложение установлено, но администратор Битрикс24 открыл доступ к нему только конкретным пользователям

403

PORTAL_DELETED
Portal was deleted

Публичная часть сайта закрыта. Чтобы открыть ее на коробочной установке, отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

Продолжите изучение