метод REST scope: calendar

calendar.resource.booking.list

Получить бронирования ресурсов по фильтру

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

Описание

Метод получает бронирования ресурсов по фильтру.

Параметры

filter object обязательный

Поля фильтра

Параметр filter

resourceTypeIdList array обязательный

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

Получить идентификаторы можно методом calendar.resource.list

from date необязательный

Дата начала периода

to date необязательный

Дата окончания периода

resourceIdList array обязательный

Список идентификаторов бронирований ресурсов из пользовательского поля типа resourcebooking у лидов или сделок в CRM.

Получить идентификаторы можно:
- универсальными методами — crm.item.get, crm.item.list
- методами для лидов — crm.lead.get, crm.lead.list
- методами для сделок — crm.deal.get, crm.deal.list

Узнать какие пользовательские поля имеют тип resourcebooking можно методом crm.lead.userfield.list для лидов и методом crm.deal.userfield.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"}}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/calendar.resource.booking.list

Ответ

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 array

Массив объектов. Каждый объект описывает бронирование

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

HTTP-статус: 400

{
    "error": "",
    "error_description": "Не задан обязательный параметр \"filter['resourceTypeIdList']\" для метода \"calendar.resource.booking.list\""
}
Код Описание Значение
Доступ запрещен Запрещен доступ к методу для внешних пользователей
Не задан обязательный параметр "filter['resourceTypeIdList']" для метода "calendar.resource.booking.list" Не передан ни один из обязательных параметров: resourceTypeIdList или resourceIdList

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

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