Получить список ресурсов booking.v1.resource.list

Если вы разрабатываете интеграции для Битрикс24 с помощью AI-инструментов (Codex, Claude Code, Cursor), подключите MCP-сервер, чтобы ассистент использовал официальную REST-документацию.

Scope: booking

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

Метод booking.v1.resource.list возвращает список ресурсов по фильтру. Является реализацией списочного метода для ресурсов.

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

FILTER
object

Объект для фильтрации списка ресурсов в формате {"field_1": "value_1", ... "field_N": "value_N"}, где

  • field_Nполе ресурса для фильтра
  • value_N — значение поля

ORDER
object

Объект для сортировки списка ресурсов в формате {"field_1": "value_1", ... "field_N": "value_N"}, где

  • field_Nполе ресурса для сортировки
  • value_N — направление сортировки

Направление сортировки может принимать значения:

  • asc — по возрастанию
  • desc — по убыванию

Значение по умолчанию — {ID: 'ASC'}

Параметры filter

Название
тип

Описание

searchQuery
string

Поисковой запрос. Ищет по подстроке в названии ресурса

isMain
string

Фильтр по настройке показа ресурса. Возможные значения:

  • Y — в колонках расписания
  • N — при пересечении ресурсов

typeId
integer

Идентификатор типа ресурса.

Список доступных типов можно узнать с помощью метода booking.v1.resourceType.list

name
string

Название ресурса

description
string

Описание ресурса

Используйте или searchQuery для поиска по подстроке или name для поиска по полному совпадению.

Параметры order

Название
тип

Описание

id
string

Сортировка по идентификатору

name
string

Сортировка по названию

Примеры кода

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

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"filter":{"searchQuery":"авто","isMain":"Y","typeId":1},"order":{"id":"ASC","name":"DESC"}}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/booking.v1.resource.list
        
curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"filter":{"searchQuery":"авто","isMain":"Y","typeId":1},"order":{"id":"ASC","name":"DESC"},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/booking.v1.resource.list
        
// callListMethod: Получает все данные сразу. Используйте только для небольших выборок (< 1000 элементов) из-за высокой нагрузки на память.
        
        try {
          const response = await $b24.callListMethod(
            'booking.v1.resource.list',
            {
              filter: {
                "searchQuery": "авто",
                "isMain": "Y",
                "typeId": 1
              },
              order: {
                id: "ASC",
                name: "DESC"
              }
            },
            (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('booking.v1.resource.list', {
            filter: {
              "searchQuery": "авто",
              "isMain": "Y",
              "typeId": 1
            },
            order: {
              id: "ASC",
              name: "DESC"
            }
          }, '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('booking.v1.resource.list', {
            filter: {
              "searchQuery": "авто",
              "isMain": "Y",
              "typeId": 1
            },
            order: {
              id: "ASC",
              name: "DESC"
            }
          }, 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(
                    'booking.v1.resource.list',
                    [
                        'filter' => [
                            'searchQuery' => 'авто',
                            'isMain'      => 'Y',
                            'typeId'      => 1,
                        ],
                        'order' => [
                            'id'   => 'ASC',
                            'name' => 'DESC',
                        ],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            if ($result->error()) {
                error_log($result->error());
                echo 'Error: ' . $result->error();
            } else {
                echo 'Success: ' . print_r($result->data(), true);
            }
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error calling booking.v1.resource.list: ' . $e->getMessage();
        }
        
BX24.callMethod(
            "booking.v1.resource.list",
            {
                filter: {
                    "searchQuery": "авто",
                    "isMain": "Y",
                    "typeId": 1
                },
                order: {
                    id: "ASC",
                    name: "DESC"
                }
            },
            result => {
                if (result.error())
                    console.error(result.error());
                else
                    console.dir(result.data());
            }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'booking.v1.resource.list',
            [
                'filter' => [
                    'searchQuery' => 'авто',
                    'isMain' => 'Y',
                    'typeId' => 1
                ],
                'order' => [
                    'id' => 'ASC',
                    'name' => 'DESC'
                ]
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';
        

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

HTTP-статус: 200

{
            "result": {
                "resource": [
                    {
                        "confirmationCounterDelay": 10800,
                        "confirmationNotificationDelay": 86400,
                        "confirmationNotificationRepetitions": null,
                        "confirmationNotificationRepetitionsInterval": 10800,
                        "delayedCounterDelay": 300,
                        "delayedNotificationDelay": 300,
                        "description": null,
                        "id": 5,
                        "infoNotificationDelay": null,
                        "isConfirmationNotificationOn": "Y",
                        "isDelayedNotificationOn": "Y",
                        "isFeedbackNotificationOn": "N",
                        "isInfoNotificationOn": "Y",
                        "isMain": "Y",
                        "isReminderNotificationOn": "Y",
                        "name": "Легковой автомобиль 1",
                        "reminderNotificationDelay": -1,
                        "templateTypeConfirmation": "inanimate",
                        "templateTypeDelayed": "inanimate",
                        "templateTypeFeedback": "inanimate",
                        "templateTypeInfo": "inanimate",
                        "templateTypeReminder": "base",
                        "typeId": 1
                    },
                    {
                        "confirmationCounterDelay": 10800,
                        "confirmationNotificationDelay": 86400,
                        "confirmationNotificationRepetitions": null,
                        "confirmationNotificationRepetitionsInterval": 10800,
                        "delayedCounterDelay": 300,
                        "delayedNotificationDelay": 300,
                        "description": null,
                        "id": 7,
                        "infoNotificationDelay": null,
                        "isConfirmationNotificationOn": "Y",
                        "isDelayedNotificationOn": "Y",
                        "isFeedbackNotificationOn": "N",
                        "isInfoNotificationOn": "Y",
                        "isMain": "Y",
                        "isReminderNotificationOn": "Y",
                        "name": "Легковой автомобиль 2",
                        "reminderNotificationDelay": -1,
                        "templateTypeConfirmation": "inanimate",
                        "templateTypeDelayed": "inanimate",
                        "templateTypeFeedback": "inanimate",
                        "templateTypeInfo": "inanimate",
                        "templateTypeReminder": "base",
                        "typeId": 1
                    }
                ]
            },
            "time": {
                "start": 1746540454.261779,
                "finish": 1746540454.303483,
                "duration": 0.04170393943786621,
                "processing": 0.009412050247192383,
                "date_start": "2025-05-06T17:07:34+03:00",
                "date_finish": "2025-05-06T17:07:34+03:00",
                "operating_reset_at": 1746541054,
                "operating": 0
            }
        }
        

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

Название
тип

Описание

result
object

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

Cодержит массив объектов с информацией о ресурсах. Структура описана ниже

time
time

Информация о времени выполнения запроса

Ресурс

confirmationCounterDelay
integer

Время до записи в секундах, после которого загорается счетчик не подтвержденной записи

confirmationDelay
integer

Время до записи в секундах, когда клиенту приходит первое сообщение для подтверждения записи

confirmationRepetitions
integer

Количество сообщений, которые приходят клиенту для подтверждения записи, не учитывая первого

confirmationRepetitionsInterval
integer

Интервал между сообщениями о подтверждении записи, в секундах

delayedCounterDelay
integer

Время в секундах, через сколько включить счетчик в календаре

delayedDelay
integer

Время в секундах, через сколько отправить клиенту сообщение об опоздании

description
string

Описание ресурса

id
integer

Идентификатор ресурса

infoDelay
integer

Задержка в секундах, после которой клиенту приходит сообщение о записи

isConfirmationNotificationOn
string

Автоматическое подтверждение записи. Возможные значения:

  • Y — включено
  • N — выключено

isDelayedNotificationOn
string

Напоминание, когда клиент опаздывает. Возможные значения:

  • Y — включено
  • N — выключено

isFeedbackNotificationOn
string

Запрос обратной связи. Возможные значения:

  • Y — включено
  • N — выключено

isInfoNotificationOn
string

Сообщение клиенту о записи. Возможные значения:

  • Y — включено
  • N — выключено

isMain
string

Как показывать ресурс. Возможные значения:

  • Y — в колонках расписания
  • N — при пересечении ресурсов

isReminderNotificationOn
string

Напоминание о записи. Возможные значения:

  • Y — включено
  • N — выключено

name
string

Название ресурса

reminderDelay
integer

Время до записи в секундах, за которое клиенту приходит напоминание о записи.
Значение -1 — утром в день записи

templateTypeConfirmation
string

Тип шаблона сообщения о подтверждении записи. Возможные значения:

  • inanimate — шаблон для бронирования оборудования и помещений
  • animate — шаблон для записи к специалистам

templateTypeDelayed
string

Тип шаблона сообщения об опоздании. Возможные значения:

  • inanimate — шаблон для бронирования оборудования и помещений
  • animate — шаблон для записи к специалистам

templateTypeFeedback
string

Тип шаблона сообщения для запроса обратной связи. Возможные значения:

  • inanimate — шаблон для бронирования оборудования и помещений
  • animate — шаблон для записи к специалистам

templateTypeInfo
string

Тип шаблона сообщения о записи. Возможные значения:

  • inanimate — шаблон для бронирования оборудования и помещений
  • animate — шаблон для записи к специалистам

templateTypeReminder
string

Тип шаблона сообщения для напоминания. Возможные значения: base

typeId
integer

Идентификатор типа ресурса.

Получить информацию о типе можно с помощью метода booking.v1.resourceType.get

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

HTTP-статус: 400

{
            "error": "",
            "error_description": "Invalid value {ASC} to match with parameter {order}. Should be value of type array."
        }
        

Название
тип

Описание

error
string

Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания

error_description
error_description

Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде

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

Код

Описание

Значение

100

Invalid value to match with parameter {order}. Should be value of type array

В параметр order передан не объект

100

Invalid value to match with parameter {filter}. Should be value of type array

В параметр filter передан не объект

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

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

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

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

Предыдущая
Следующая