метод REST scope: booking

booking.v1.resource.list

Получить список ресурсов

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

Описание

Метод 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 необязательный

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

Параметры 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

Ответ

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

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

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

HTTP-статус: 400

{
    "error": "",
    "error_description": "Invalid value {ASC} to match with parameter {order}. Should be value of type array."
}
Код Описание Значение
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 передан не объект

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

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