метод REST scope: calendar

calendar.section.get

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

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

Описание

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

Параметры

type string обязательный

Тип календаря:
- user — календарь пользователя
- group — календарь группы
- company_calendar — календарь компании
- location — календарь переговорной комнаты. Используется для бронирования времени в календаре переговорной комнаты через стороннее приложение
- другие типы, в том числе пользовательские

ownerId integer обязательный

Идентификатор владельца календаря.

Параметр можно не передавать, если тип календаря user. В этом случае используется идентификатор текущего пользователя.

Для типа календаря location параметр ownerId должен иметь значение 0

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

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"type":"user","ownerId":1}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/calendar.section.get

Ответ

HTTP-статус: 200

{
    "result": [
        {
            "ID": "190",
            "NAME": "New Section",
            "GAPI_CALENDAR_ID": null,
            "DESCRIPTION": "Description for section",
            "COLOR": "#9cbeee",
            "TEXT_COLOR": "#283000",
            "EXPORT": {
                "ALLOW": true
            },
            "CAL_TYPE": "user",
            "OWNER_ID": "1",
            "CREATED_BY": "1",
            "DATE_CREATE": "2024-12-10 06:36:00",
            "TIMESTAMP_X": "2024-12-10 06:36:00",
            "CAL_DAV_CON": null,
            "SYNC_TOKEN": null,
            "PAGE_TOKEN": null,
            "EXTERNAL_TYPE": "local",
            "ACCESS": {
                "D114": 17,
                "G2": 13,
                "U2": 15,
                "U1": 19
            },
            "IS_COLLAB": false,
            "PERM": {
                "view_time": true,
                "view_title": true,
                "view_full": true,
                "add": true,
                "edit": true,
                "edit_section": true,
                "access": true
            }
        },
        {
            "ID": "191",
            ...
        }
        {
            "ID": "192",
            ...
        }
    ],
    "time": {
        "start": 1733828946.418185,
        "finish": 1733828946.650208,
        "duration": 0.23202300071716309,
        "processing": 0.0054471492767333984,
        "date_start": "2024-12-08T11:09:06+00:00",
        "date_finish": "2024-12-08T11:09:06+00:00"
    }
}

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

result array

Массив календарей

ID string

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

NAME string

Название календаря

GAPI_CALENDAR_ID string

Идентификатор синхронизации

DESCRIPTION string

Описание календаря

COLOR string

Цвет календаря

TEXT_COLOR string

Цвет текста в календаре

CAL_TYPE string

Тип календаря

OWNER_ID string

Идентификатор владельца календаря.

Для типа Календарь пользователя user поле содержит идентификатор пользователя. Для Календаря группы group — идентификатор группы

CREATED_BY string

Идентификатор создателя календаря

DATE_CREATE datetime

Дата создания календаря

TIMESTAMP_X datetime

Дата изменения календаря

CAL_DAV_CON string

Идентификатор синхронизации

SYNC_TOKEN string

Идентификатор синхронизации

PAGE_TOKEN string

Идентификатор синхронизации

EXTERNAL_TYPE string

Тип провайдера для синхронизации

ACCESS object

Объект данных доступа к календарю.

Ключ объекта — идентификатор прав доступа. Получить название прав доступа можно методом access.name. Определить права доступа для текущего пользователя — методом user.access.

Значение обьекта содержит числовой идентификатор разрешения на право доступа. Индентификаторы разрешения на право доступа отличаются на разных порталах. На текущий момент узнать все идентификаторы может только администратор портала в коробочной версии Битрикс24

IS_COLLAB boolean

Флаг принадлежности календаря к коллабе

PERM object

Объект прав доступа текущего пользователя к календарю

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

HTTP-статус: 400

{
    "error": "",
    "error_description": "Не задан обязательный параметр \"type\" для метода \"calendar.section.get\""
}
Код Описание Значение
Не задан обязательный параметр "type" для метода "calendar.section.get" Не передан обязательный параметр type
Не задан обязательный параметр "ownerId" для метода "calendar.section.get" Не передан обязательный параметр ownerId и параметр type не равен user
Доступ запрещен Запрещен доступ к методу для внешних пользователей

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

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