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
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
// This snippet is an ES module: top-level await requires type="module" or a bundler.
// $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame } from '@bitrix24/b24jssdk'
declare const $b24: B24Frame
// Shape of each resource returned in result.resource[]
type ResourceItem = {
confirmationCounterDelay: number
confirmationNotificationDelay: number
confirmationNotificationRepetitions: number | null
confirmationNotificationRepetitionsInterval: number
delayedCounterDelay: number
delayedNotificationDelay: number
description: string | null
id: number
infoNotificationDelay: number | null
isConfirmationNotificationOn: string
isDelayedNotificationOn: string
isFeedbackNotificationOn: string
isInfoNotificationOn: string
isMain: string
isReminderNotificationOn: string
name: string
reminderNotificationDelay: number
templateTypeConfirmation: string
templateTypeDelayed: string
templateTypeFeedback: string
templateTypeInfo: string
templateTypeReminder: string
typeId: number
}
try {
// booking.v1.resource.list returns a single page (max 50 records). For the whole result set
// use a list helper: $b24.actions.v2.callList.make() returns every record as one
// array, $b24.actions.v2.fetchList.make() yields them in chunks (async generator).
// NOTE: the list helpers do not accept `order` (it is excluded from their params, so
// passing it is a TS error) — keep this call.make + `start` variant when sort matters.
const response = await $b24.actions.v2.call.make<{ resource: ResourceItem[] }>({
method: 'booking.v1.resource.list',
params: {
filter: {
searchQuery: 'auto',
isMain: 'Y',
typeId: 1,
},
order: {
id: 'ASC',
name: 'DESC',
},
start: 0,
},
requestId: Text.getUuidRfc4122()
})
// The payload is available only on a successful response
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
} else {
const result = response.getData()!.result
console.info('Resources:', result.resource, 'Count:', result.resource.length)
}
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
async function fetchResourceList() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
// booking.v1.resource.list returns a single page (max 50 records). For the whole result set
// use a list helper: $b24.actions.v2.callList.make() returns every record as one
// array, $b24.actions.v2.fetchList.make() yields them in chunks (async generator).
// NOTE: the list helpers do not accept `order` (it is excluded from their params, so
// passing it is a TS error) — keep this call.make + `start` variant when sort matters.
const response = await $b24.actions.v2.call.make({
method: 'booking.v1.resource.list',
params: {
filter: {
searchQuery: 'auto',
isMain: 'Y',
typeId: 1,
},
order: {
id: 'ASC',
name: 'DESC',
},
start: 0,
},
requestId: B24Js.Text.getUuidRfc4122()
})
// The payload is available only on a successful response
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
return
}
const result = response.getData().result
console.info('Resources:', result.resource, 'Count:', result.resource.length)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', fetchResourceList)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.booking.v1.resource.list(filter={
"typeId": 1,
"searchQuery": "авто",
"isMain": "Y",
}, order={
"id": "desc",
"name": "DESC",
}).response
result = bitrix_response.result
print(result)
except BitrixAPIError as error:
print('Ошибка Bitrix API', f'error: {error.error}', f'error_description: {error.error_description}', sep='\n')
except BitrixSDKException as error:
print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
print(f"Непредвиденная ошибка: {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>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "booking.v1.resource.list", b24.Params{
"FILTER": b24.Params{
"searchQuery": "авто",
"isMain": "Y",
"typeId": 1,
},
"ORDER": b24.Params{
"id": "ASC",
"name": "DESC",
},
}, b24.WithIdempotent())
if err != nil {
return fmt.Errorf("booking.v1.resource.list: %w", err)
}
// Метод заворачивает ответ в объект с ключом "resource".
raw, ok := b24.Unwrap(res.Result, "resource")
if !ok {
return fmt.Errorf("в ответе нет ключа resource")
}
var items []struct {
ConfirmationCounterDelay int `json:"confirmationCounterDelay"`
ConfirmationNotificationDelay int `json:"confirmationNotificationDelay"`
ConfirmationNotificationRepetitionsInterval int `json:"confirmationNotificationRepetitionsInterval"`
DelayedCounterDelay int `json:"delayedCounterDelay"`
DelayedNotificationDelay int `json:"delayedNotificationDelay"`
ID b24.ID `json:"id"`
}
if err := json.Unmarshal(raw, &items); err != nil {
return fmt.Errorf("разбор ответа: %w", err)
}
for _, it := range items {
fmt.Println(it.ConfirmationCounterDelay)
}
Ответ
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 передан не объект |

