При разработке и поддержке проектов на платформе 1С-Битрикс критически важно использовать современные стандарты D7 API. В этом руководстве мы детально изучим тему «Получить список записей из листа ожидания booking.v1.waitlist.list», разберем архитектурные особенности и предоставим готовые к интеграции примеры кода.

Получить список записей из листа ожидания booking.v1.waitlist.list

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

Метод booking.v1.waitlist.list возвращает список записей из листа ожидания по фильтру.

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

Параметр createdWithin {#createdWithin}

Примеры кода

• cURL (Webhook)

    curl -X POST \
    -H "Content-Type: application/json" \
    -H "Accept: application/json" \
    -d '{"filter":{"createdWithin":{"from":"01.04.2025","to":"16.04.2025"}}}' \
    https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webbhook_here**/booking.v1.waitlist.list

• cURL (OAuth)

    curl -X POST \
    -H "Content-Type: application/json" \
    -H "Accept: application/json" \
    -d '{"filter":{"createdWithin":{"from":"01.04.2025","to":"16.04.2025"}},"auth":"**put_access_token_here**"}' \
    https://**put_your_bitrix24_address**/rest/booking.v1.waitlist.list

• JS

    // callListMethod рекомендуется использовать, когда необходимо получить весь набор списочных данных и объём записей относительно невелик (до примерно 1000 элементов). Метод загружает все данные сразу, что может привести к высокой нагрузке на память при работе с большими объемами.
    
    try {
      const response = await $b24.callListMethod(
        'booking.v1.waitlist.list',
        {
          filter: {
            createdWithin: {
              from: "01.04.2025",
              to: "16.04.2025",
            }
          }
        },
        (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.waitlist.list', {
        filter: {
          createdWithin: {
            from: "01.04.2025",
            to: "16.04.2025",
          }
        }
      }, '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.waitlist.list', {
        filter: {
          createdWithin: {
            from: "01.04.2025",
            to: "16.04.2025",
          }
        }
      }, 0);
      const result = response.getData().result || [];
      for (const entity of result) { console.log('Entity:', entity); }
    } catch (error) {
      console.error('Request failed', error);
    }

• PHP

    try {
        $response = $b24Service
            ->core
            ->call(
                'booking.v1.waitlist.list',
                [
                    'filter' => [
                        'createdWithin' => [
                            'from' => '01.04.2025',
                            'to'   => '16.04.2025', //не включительно, будут отобраны записи с самой поздней датой 15.04.2025
                        ],
                    ],
                ]
            );
    
        $result = $response
            ->getResponseData()
            ->getResult();
    
        if ($result->error()) {
            error_log($result->error());
            echo 'Error: ' . $result->error();
        } else {
            echo 'Data: ' . print_r($result->data(), true);
        }
    
    } catch (Throwable $e) {
        error_log($e->getMessage());
        echo 'Error listing waitlist: ' . $e->getMessage();
    }

• BX24.js

    BX24.callMethod(
        "booking.v1.waitlist.list",
        {
            filter: {
                createdWithin: {
                    from: "01.04.2025", 
                    to: "16.04.2025", //не включительно, будут отобраны записи с самой поздней датой 15.04.2025
                }
            }
        },
        result => {
            if (result.error())
                console.error(result.error());
            else
                console.dir(result.data());
        }
    );

• PHP CRest

    require_once('crest.php');

    $result = CRest::call(
        'booking.v1.waitlist.list',
        [
            'filter' => [
                'createdWithin' => [
                    'from' => '01.04.2025',
                    'to' => '16.04.2025' //не включительно, будут отобраны записи с самой поздней датой 15.04.2025
                ]
            ]
        ]
    );

    echo '<PRE>';
    print_r($result);
    echo '</PRE>';

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

HTTP-статус: 200

{
    "result": {
        "waitList": [
            {
                "id": 15,
                "note": "заметка"
            },
            {
                "id": 16,
                "note": "заметка"
            }
        ]
    },
    "time": {
     "start": 1724068028.331234,
     "finish": 1724068028.726591,
     "duration": 0.3953571319580078,
     "processing": 0.13033390045166016,
     "date_start": "2025-01-21T13:47:08+02:00",
     "date_finish": "2025-01-21T13:47:08+02:00",
     "operating": 0
    }
}

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

Запись в листе ожидания {#waitList}

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

HTTP-статус: 400

{
    "error": 422,
    "error_description": "Invalid date"
}

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

• [](./booking-v1-waitlist-createfrombooking)
• [](./booking-v1-waitlist-update)
• [](./booking-v1-waitlist-get)
• [](./booking-v1-waitlist-add)
• [](./booking-v1-waitlist-delete)