метод REST scope: calendar

calendar.user.settings.get

Получить пользовательские настройки календаря

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

Описание

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

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

Примеры запроса

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.user.settings.get

Ответ

HTTP-статус: 200

{
    "result": {
        "view": "month",
        "meetSection": "4",
        "crmSection": "4",
        "showDeclined": true,
        "denyBusyInvitation": false,
        "collapseOffHours": "N",
        "showWeekNumbers": "N",
        "showTasks": "Y",
        "syncTasks": "N",
        "showCompletedTasks": "N",
        "lastUsedSection": "false",
        "sendFromEmail": "",
        "defaultSections": {
            "user1": "4",
            "group6": "49"
        },
        "syncPeriodPast": "3",
        "syncPeriodFuture": "12",
        "defaultReminders": {
            "fullDay": [
                {
                    "type": "min",
                    "count": 15
                }
            ],
            "withTime": [
                {
                    "type": "min",
                    "count": 50
                }
            ]
        },
        "timezoneName": "Europe/Riga",
        "timezoneOffsetUTC": 7200,
        "timezoneDefaultName": "",
        "work_time_start": "9.00",
        "work_time_end": "19.00"
    },
    "time": {
        "start": 1734434829.455204,
        "finish": 1734434829.797482,
        "duration": 0.34227800369262695,
        "processing": 0.0038161277770996094,
        "date_start": "2024-12-17T11:27:09+00:00",
        "date_finish": "2024-12-17T11:27:09+00:00"
    }
}

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

result object

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

view string

Стандартное представление для календаря. Возможные значения:
- day — день
- week — неделя
- month — месяц
- list — список

meetSection string

Календарь для приглашений

crmSection string

Календарь для CRM

showDeclined boolean

Показывать события, в которых пользователь отказался принять участие

denyBusyInvitation boolean

Запрещать приглашать в событие, если время занято

collapseOffHours string

Скрывать нерабочее время в календаре в недельном и дневном представлении. Возможные значения:
- Y — скрывать
- N — не скрывать

showWeekNumbers string

Показывать номер недель. Возможные значения:
- Y — показывать
- N — не показывать

showTasks string

Отображать задачи в календаре. Возможные значения:
- Y — отображать
- N — не отображать

syncTasks string

Синхронизировать календарь задач. Возможные значения:
- Y — да
- N — нет

showCompletedTasks string

Отображать завершенные задачи. Возможные значения:
- Y — отображать
- N — не отображать

lastUsedSection string

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

Значение по умолчанию — false

sendFromEmail string

E-mail для отправки почтовых приглашений

defaultSections object

Настройки предустановленных календарей.

Ключем объекта настроек может быть:
- user[id] — тип Календарь пользователя c идентификатором пользователя. Например, user12 соответствует календарю пользователя с идентификатором 12
- group[id] — тип Календарь группы с идентификатором группы. Например, group36 соответствует календарю группы с идентификатором 36

Значением объекта является идентификатор календаря

syncPeriodPast string

Количество месяцев для синхронизации в прошлом периоде

syncPeriodFuture string

Количество месяцев для синхронизации в будущем периоде

defaultReminders object

Объект со стандартными настройками напоминаний о событии

timezoneName string

Таймзона календаря

timezoneOffsetUTC integer

Смешение таймзоны относительно UTC в секундах

timezoneDefaultName string

Если параметр timezoneName не установлен, здесь будет указан часовой пояс из параметра timezoneOffsetUTC

work_time_start string

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

work_time_end string

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

Что будем искать? Например,Продвижение

Этот сайт использует куки-файлы. Оставаясь на сайте, Вы соглашаетесь на их использование. Для получения дополнительной информации, пожалуйста, ознакомьтесь с политикой в отношении персональных данных.