Получить бронирования ресурсов по фильтру calendar.resource.booking.list
Scope:
calendarКто может выполнять метод: любой пользователь
Метод получает бронирования ресурсов по фильтру.
Параметры метода
Обязательные параметры отмечены *
|
Название |
Описание |
|
filter* |
Поля фильтра |
Параметр filter
Обязательные параметры отмечены *
|
Название |
Описание |
|
resourceTypeIdList* |
Cписок идентификаторов ресурсов. Получить идентификаторы можно методом calendar.resource.list |
|
from |
Дата начала периода |
|
to |
Дата окончания периода |
|
resourceIdList* |
Список идентификаторов бронирований ресурсов из пользовательского поля типа Получить идентификаторы можно:
Узнать какие пользовательские поля имеют тип |
В методе calendar.resource.booking.list необходимо использовать только один из двух обязательных параметров: resourceTypeIdList или resourceIdList. Вместе эти параметры использовать нельзя.
Примеры кода
Пример 1. Оценить занятость ресурсов за период, например, для создания собственных представлений занятости или для использования в логике приложения.
Как использовать примеры в документации
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"filter":{"resourceTypeIdList":[10852,10888,10873,10871,10853],"from":"2024-06-20","to":"2024-08-20"}}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/calendar.resource.booking.list
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"filter":{"resourceTypeIdList":[10852,10888,10873,10871,10853],"from":"2024-06-20","to":"2024-08-20"},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/calendar.resource.booking.list
// callListMethod: Получает все данные сразу. Используйте только для небольших выборок (< 1000 элементов) из-за высокой нагрузки на память.
try {
const response = await $b24.callListMethod(
'calendar.resource.booking.list',
{
filter: {
resourceTypeIdList: [10852, 10888, 10873, 10871, 10853],
from: '2024-06-20',
to: '2024-08-20',
}
},
(progress) => { console.log('Progress:', progress) }
);
const items = response.getData() || [];
for (const entity of items) { console.log('Entity:', entity); }
} catch (error) {
console.error('Request failed', error);
}
// fetchListMethod: Выбирает данные по частям с помощью итератора. Используйте для больших объемов данных для эффективного потребления памяти.
try {
const generator = $b24.fetchListMethod('calendar.resource.booking.list', {
filter: {
resourceTypeIdList: [10852, 10888, 10873, 10871, 10853],
from: '2024-06-20',
to: '2024-08-20',
}
}, 'ID');
for await (const page of generator) {
for (const entity of page) { console.log('Entity:', entity); }
}
} catch (error) {
console.error('Request failed', error);
}
// callMethod: Ручное управление постраничной навигацией через параметр start. Используйте для точного контроля над пакетами запросов. Для больших данных менее эффективен, чем fetchListMethod.
try {
const response = await $b24.callMethod('calendar.resource.booking.list', {
filter: {
resourceTypeIdList: [10852, 10888, 10873, 10871, 10853],
from: '2024-06-20',
to: '2024-08-20',
}
}, 0);
const result = response.getData().result || [];
for (const entity of result) { console.log('Entity:', entity); }
} catch (error) {
console.error('Request failed', error);
}
try {
$response = $b24Service
->core
->call(
'calendar.resource.booking.list',
[
'filter' => [
'resourceTypeIdList' => [10852, 10888, 10873, 10871, 10853],
'from' => '2024-06-20',
'to' => '2024-08-20',
],
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . print_r($result, true);
// Нужная вам логика обработки данных
processData($result);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error fetching resource booking list: ' . $e->getMessage();
}
BX24.callMethod(
'calendar.resource.booking.list',
{
filter: {
resourceTypeIdList: [10852, 10888, 10873, 10871, 10853],
from: '2024-06-20',
to: '2024-08-20',
}
}
);
require_once('crest.php');
$result = CRest::call(
'calendar.resource.booking.list',
[
'filter' => [
'resourceTypeIdList' => [10852, 10888, 10873, 10871, 10853],
'from' => '2024-06-20',
'to' => '2024-08-20'
]
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
Пример 2. Выбрать бронирования по их идентификаторам из пользовательских полей CRM сущности.
Как использовать примеры в документации
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"filter":{"resourceIdList":[10,18,17]}}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/calendar.resource.booking.list
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"filter":{"resourceIdList":[10,18,17]},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/calendar.resource.booking.list
// callListMethod: Получает все данные сразу. Используйте только для небольших выборок (< 1000 элементов) из-за высокой нагрузки на память.
try {
const response = await $b24.callListMethod(
'calendar.resource.booking.list',
{
filter: {
resourceIdList: [10, 18, 17]
}
},
(progress) => { console.log('Progress:', progress) }
)
const items = response.getData() || []
for (const entity of items) { console.log('Entity:', entity) }
} catch (error) {
console.error('Request failed', error)
}
// fetchListMethod: Выбирает данные по частям с помощью итератора. Используйте для больших объемов данных для эффективного потребления памяти.
try {
const generator = $b24.fetchListMethod('calendar.resource.booking.list', {
filter: {
resourceIdList: [10, 18, 17]
}
}, 'ID')
for await (const page of generator) {
for (const entity of page) { console.log('Entity:', entity) }
}
} catch (error) {
console.error('Request failed', error)
}
// callMethod: Ручное управление постраничной навигацией через параметр start. Используйте для точного контроля над пакетами запросов. Для больших данных менее эффективен, чем fetchListMethod.
try {
const response = await $b24.callMethod('calendar.resource.booking.list', {
filter: {
resourceIdList: [10, 18, 17]
}
}, 0)
const result = response.getData().result || []
for (const entity of result) { console.log('Entity:', entity) }
} catch (error) {
console.error('Request failed', error)
}
try {
$response = $b24Service
->core
->call(
'calendar.resource.booking.list',
[
'filter' => [
'resourceIdList' => [10, 18, 17]
]
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . print_r($result, true);
// Нужная вам логика обработки данных
processData($result);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error fetching resource booking list: ' . $e->getMessage();
}
BX24.callMethod(
'calendar.resource.booking.list',
{
filter: {
resourceIdList: [10, 18, 17]
}
}
);
require_once('crest.php');
$result = CRest::call(
'calendar.resource.booking.list',
[
'filter' => [
'resourceIdList' => [10, 18, 17]
]
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
Обработка ответа
HTTP-статус: 200
{
"result": [
{
"ID": "1408",
"PARENT_ID": "1408",
"DELETED": "N",
"CAL_TYPE": "resource",
"OWNER_ID": "0",
"NAME": "Бронирование",
"DATE_FROM": "20.12.2024 00:00:00",
"DATE_TO": "21.12.2024 00:00:00",
"TZ_FROM": "Europe/Riga",
"TZ_TO": "Europe/Riga",
"TZ_OFFSET_FROM": "7200",
"TZ_OFFSET_TO": "7200",
"DATE_FROM_TS_UTC": "1734652800",
"DATE_TO_TS_UTC": "1734739200",
"DT_SKIP_TIME": "Y",
"DT_LENGTH": 172800,
"EVENT_TYPE": "#resourcebooking#",
"CREATED_BY": "1",
"DATE_CREATE": "18.12.2024 13:55:35",
"TIMESTAMP_X": "18.12.2024 13:55:35",
"DESCRIPTION": "Услуга: some",
"IS_MEETING": false,
"MEETING_STATUS": "Y",
"MEETING_HOST": "0",
"VERSION": "1",
"SECTION_ID": "198",
"DATE_FROM_FORMATTED": "Fri Dec 20 2024",
"DATE_TO_FORMATTED": "Sat Dec 21 2024",
"SECT_ID": "198",
"RESOURCE_BOOKING_ID": "10"
},
{
"ID": "1409",
...
}
],
"time": {
"start": 1733318565.183275,
"finish": 1733318565.695058,
"duration": 0.5117831230163574,
"processing": 0.29406094551086426,
"date_start": "2024-12-04T13:22:45+00:00",
"date_finish": "2024-12-04T13:22:45+00:00"
}
}
Возвращаемые данные
|
Название |
Описание |
|
result |
Массив объектов. Каждый объект описывает бронирование |
Объект бронирования
Технически бронирование — это событие календаря. Метод получает набор полей, аналогичный полям события календаря. Некоторые поля остаются пустыми, так как они неактуальны для бронирования. Ниже перечислены только актуальные или заполненные поля.
|
Название |
Описание |
|
ID |
Идентификатор бронирования |
|
PARENT_ID |
Для объекта бронирования всегда равен полю |
|
DELETED |
Флаг показывает удалено ли бронирование. Возможные значения:
|
|
CAL_TYPE |
Тип календаря, в котором находится бронирование |
|
OWNER_ID |
Для объекта бронирования всегда равно |
|
NAME |
Название бронирования |
|
DATE_FROM |
Дата начала бронирования |
|
DATE_TO |
Дата окончания бронирования |
|
TZ_FROM |
Таймзона даты начала бронирования |
|
TZ_TO |
Таймзона даты окончания бронирования |
|
TZ_OFFSET_FROM |
Смещение времени начала бронирования относительно UTC в секундах |
|
TZ_OFFSET_TO |
Смещение времени окончания бронирования относительно UTC в секундах |
|
DATE_FROM_TS_UTC |
Дата и время начала бронирования в UTC в формате timestamp |
|
DATE_TO_TS_UTC |
Дата и время окончания бронирования в UTC в формате timestamp |
|
DT_SKIP_TIME |
Флаг показывает, длится ли бронирование целый день. Возможные значения:
|
|
DT_LENGTH |
Длительность бронирования в секундах |
|
EVENT_TYPE |
Тип бронирования |
|
CREATED_BY |
Идентификатор пользователя, который создал бронирование |
|
DATE_CREATE |
Дата создания бронирования |
|
TIMESTAMP_X |
Дата изменения бронирования |
|
DESCRIPTION |
Описание бронирования |
|
IS_MEETING |
Для объекта бронирования всегда |
|
MEETING_STATUS |
Для объекта бронирования всегда |
|
MEETING_HOST |
Для объекта бронирования всегда |
|
VERSION |
Версия изменений бронирования |
|
SECTION_ID |
Идентификатор ресурса, в котором расположено бронирование |
|
DATE_FROM_FORMATTED |
Форматированная дата начала бронирования |
|
DATE_TO_FORMATTED |
Форматированная дата окончания бронирования |
|
SECT_ID |
Идентификатор ресурса, в котором расположено бронирование |
|
RESOURCE_BOOKING_ID |
Идентификатор бронирования |
Обработка ошибок
HTTP-статус: 400
{
"error": "",
"error_description": "Не задан обязательный параметр "filter['resourceTypeIdList']" для метода "calendar.resource.booking.list""
}
|
Название |
Описание |
|
error |
Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания |
|
error_description |
Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде |
Возможные коды ошибок
|
Код |
Сообщение об ошибке |
Описание |
|
Пустая строка |
Доступ запрещен |
Запрещен доступ к методу для внешних пользователей |
|
Пустая строка |
Не задан обязательный параметр "filter['resourceTypeIdList']" для метода "calendar.resource.booking.list" |
Не передан ни один из обязательных параметров: |
Статусы и коды системных ошибок
HTTP-статус: 20x, 40x, 50x
Описанные ниже ошибки могут возникнуть при вызове любого метода
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Текущий метод не разрешен для вызова с помощью batch |
|
|
|
Превышена максимальная длина параметров, переданных в метод batch |
|
|
|
Неверный access-токен или код вебхука |
|
|
|
Для вызовов методов требуется использовать протокол HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих планах |
|
|
|
У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав |
|
|
|
Манифест недоступен |
|
|
|
Запрос требует более высоких привилегий, чем предоставляет токен вебхука |
|
|
|
Предоставленный access-токен доступа истек |
|
|
|
Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |
Продолжите изучение
- Бронирование ресурсов: обзор методов
- Добавить новый ресурс calendar.resource.add
- Обновить ресурс calendar.resource.update
- Получить список всех ресурсов calendar.resource.list
- Удалить ресурс calendar.resource.delete