Получить занятость пользователей из списка calendar.accessibility.get

Scope: calendar

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

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

Параметры метода

Обязательные параметры отмечены *

Название `тип`	Описание
users* `array`	Массив идентификаторов пользователей
from* `date`	Дата начала периода для определения занятости в формате `ГГГГ-ММ-ДД`. Например, `2024-06-20`
to* `date`	Дата окончания периода для определения занятости в формате `ГГГГ-ММ-ДД`. Например, `2024-12-20`

Примеры кода

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

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"from":"2024-06-20","to":"2024-12-20","users":[1,2,34]}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/calendar.accessibility.get

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"from":"2024-06-20","to":"2024-12-20","users":[1,2,34],"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/calendar.accessibility.get

try
        {
        	const response = await $b24.callMethod(
        		'calendar.accessibility.get',
        		{
        			from: '2024-06-20',
        			to: '2024-12-20',
        			users: [1, 2, 34]
        		}
        	);
        	
        	const result = response.getData().result;
        	// Нужная вам логика обработки данных
        	processResult(result);
        }
        catch( error )
        {
        	console.error('Error:', error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'calendar.accessibility.get',
                    [
                        'from'  => '2024-06-20',
                        'to'    => '2024-12-20',
                        'users' => [1, 2, 34]
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
            // Нужная вам логика обработки данных
            processData($result);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error getting calendar accessibility: ' . $e->getMessage();
        }

BX24.callMethod(
            'calendar.accessibility.get',
            {
                from: '2024-06-20',
                to: '2024-12-20',
                users: [1, 2, 34]
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'calendar.accessibility.get',
            [
                'from' => '2024-06-20',
                'to' => '2024-12-20',
                'users' => [1, 2, 34]
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

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

HTTP-статус: 200

{
            "result": {
                "1": [
                    {
                        "ID": "1213",
                        "NAME": "Event name",
                        "DATE_FROM": "02.12.2024 11:00:00",
                        "DATE_TO": "02.12.2024 12:00:00",
                        "DATE_FROM_TS_UTC": "1733158800",
                        "DATE_TO_TS_UTC": "1733162400",
                        "~USER_OFFSET_FROM": -21600,
                        "~USER_OFFSET_TO": -21600,
                        "DT_SKIP_TIME": "N",
                        "TZ_FROM": "America/Managua",
                        "TZ_TO": "America/Managua",
                        "ACCESSIBILITY": "busy",
                        "IMPORTANCE": "normal",
                        "EVENT_TYPE": "#collab#"
                    },
                    {
                        "ID": "1216",
                        ...
                    }
                ],
                "2": [
                    {
                        "ID": 1,
                        ...
                    },
                    {
                        "ID": 2,
                        ...
                    }
                ],
                "34": []
            }
        }

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

Название
тип

Описание

result
object

Результат содержит объект.

Ключ объекта — это идентификатор пользователя из запроса.

Значение — массив объектов, каждый из которых описывает событие, в котором занят пользователь в указанный период

Объект события

Название `тип`	Описание
ID `string`	Идентификатор события
NAME `string`	Название события
DATE_FROM `datetime`	Дата и время начала события
DATE_TO `datetime`	Дата и время окончания события
DATE_FROM_TS_UTC `string`	Дата и время начала события в UTC в формате timestamp
DATE_TO_TS_UTC `string`	Дата и время окончания события в UTC в формате timestamp
~USER_OFFSET_FROM `integer`	Смещение времени начала события относительно UTC в секундах
~USER_OFFSET_TO `integer`	Смещение времени окончания события относительно UTC в секундах
DT_SKIP_TIME `integer`	Флаг отображающий что событие длится целый день. Возможные значения: `Y` — целый день `N` — не целый день
TZ_FROM `integer`	Таймзона даты начала события
TZ_TO `integer`	Таймзона даты окончания события
ACCESSIBILITY `integer`	Доступность участников события. Возможные значения: `busy` — занят `absent` — отсутствую `quest` — под вопросом `free` — свободен
IMPORTANCE `string`	Важность события. Возможные значения: `high` — высокая `normal` — средняя `low`— низкая
EVENT_TYPE `string`	Некоторые события содержат информацию о способе создания. Событие может быть создано через: `#shared#` — слоты календаря `#shared_crm#` — слоты CRM `#collab#` — коллабу `#shared_collab#` — слоты коллабы

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

HTTP-статус: 400

{
            "error": "",
            "error_description": "Не задан обязательный параметр "from" для метода "calendar.accessibility.get""
        }

Название `тип`	Описание
error `string`	Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания
error_description `error_description`	Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде

Возможные коды ошибок

Код	Сообщение об ошибке	Описание
Пустая строка	Не задан обязательный параметр "from" для метода "calendar.accessibility.get"	Не передан обязательный параметр `from`
Пустая строка	Не задан обязательный параметр "to" для метода "calendar.accessibility.get"	Не передан обязательный параметр `to`
Пустая строка	Не задан обязательный параметр "users" для метода "calendar.accessibility.get"	Не передан обязательный параметр `users`
Пустая строка	Доступ запрещен	Запрещен доступ к методу для внешних пользователей

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

HTTP-статус: 20x, 40x, 50x

Описанные ниже ошибки могут возникнуть при вызове любого метода

Статус	Код Текст ошибки	Описание
`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	Превышен лимит на интенсивность запросов
`405`	`ERROR_BATCH_METHOD_NOT_ALLOWED` Method is not allowed for batch usage	Текущий метод не разрешен для вызова с помощью batch
`400`	`ERROR_BATCH_LENGTH_EXCEEDED` Max batch length exceeded	Превышена максимальная длина параметров, переданных в метод batch
`401`	`NO_AUTH_FOUND` Wrong authorization data	Неверный access-токен или код вебхука
`400`	`INVALID_REQUEST` Https required	Для вызовов методов требуется использовать протокол HTTPS
`503`	`OVERLOAD_LIMIT` REST API is blocked due to overload	REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24
`403`	`ACCESS_DENIED` REST API is available only on commercial plans	REST API доступен только на коммерческих планах
`403`	`INVALID_CREDENTIALS` Invalid request credentials	У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав
`404`	`ERROR_MANIFEST_IS_NOT_AVAILABLE` Manifest is not available	Манифест недоступен
`403`	`insufficient_scope` The request requires higher privileges than provided by the webhook token	Запрос требует более высоких привилегий, чем предоставляет токен вебхука
`401`	`expired_token` The access token provided has expired	Предоставленный access-токен доступа истек
`403`	`user_access_error` The user does not have access to the application	Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям
`500`	`PORTAL_DELETED` Portal was deleted	Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

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

Установить статус участия в событии для текущего пользователя

Обзор событий

Получить занятость пользователей из списка calendar.accessibility.get

Параметры методаПараметры метода

Примеры кодаПримеры кода

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

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

Объект событияОбъект события

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

Возможные коды ошибокВозможные коды ошибок

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

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