Получить список включаемых областей для сайта landing.template.getSiteRef

Scope: landing

Кто может выполнять метод: пользователь с правом «просмотр» сайта

Метод landing.template.getSiteRef получает список включаемых областей, которые привязаны к сайту.

В ответ входят только привязки, сохраненные для сайта. Привязки, настроенные у отдельных страниц этого сайта, метод не возвращает. Чтобы получить их, используйте landing.template.getLandingRef.

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

Обязательные параметры отмечены *

Название
тип

Описание

id*
integer

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

Идентификатор сайта можно получить методом landing.site.getList

Примеры кода

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

curl -X POST \
          -H "Content-Type: application/json" \
          -d '{
            "id": 157
          }' \
          "https://**put.your-domain-here**/rest/**user_id**/**webhook_code**/landing.template.getSiteRef.json"
        
curl -X POST \
          -H "Content-Type: application/json" \
          -d '{
            "id": 157,
            "auth": "**put_access_token_here**"
          }' \
          "https://**put.your-domain-here**/rest/landing.template.getSiteRef.json"
        
try
        {
            const response = await $b24.callMethod(
                'landing.template.getSiteRef',
                {
                    id: 157
                }
            );
        
            const result = response.getData().result;
            console.info(result);
        }
        catch (error)
        {
            console.error(error);
        }
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'landing.template.getSiteRef',
                    [
                        'id' => 157,
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error getting site refs: ' . $e->getMessage();
        }
        
BX24.callMethod(
            'landing.template.getSiteRef',
            {
                id: 157
            },
            function(result)
            {
                if (result.error())
                {
                    console.error(result.error());
                }
                else
                {
                    console.info(result.data());
                }
            }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'landing.template.getSiteRef',
            [
                'id' => 157,
            ]
        );
        
        if (isset($result['error']))
        {
            echo 'Ошибка: ' . $result['error_description'];
        }
        else
        {
            echo '<pre>';
            print_r($result['result']);
            echo '</pre>';
        }

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

HTTP-статус: 200

Если для сайта настроены включаемые области, метод вернет объект со списком этих привязок. В нем для каждой области указан идентификатор страницы, которая к ней привязана.

Если для сайта не сохранены привязки включаемых областей, метод возвращает true.

{
            "result": {
                "1": 735,
                "2": 731
            },
            "time": {
                "start": 1774879192,
                "finish": 1774879192.923787,
                "duration": 0.9237871170043945,
                "processing": 0,
                "date_start": "2026-03-30T16:59:52+03:00",
                "date_finish": "2026-03-30T16:59:52+03:00",
                "operating_reset_at": 1774879792,
                "operating": 0
            }
        }
        
{
            "result": true,
            "time": {
                "start": 1774765200,
                "finish": 1774765200.411258,
                "duration": 0.4112579822540283,
                "processing": 0,
                "date_start": "2026-03-29T10:00:00+03:00",
                "date_finish": "2026-03-29T10:00:00+03:00",
                "operating_reset_at": 1774765800,
                "operating": 0
            }
        }

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

Название
тип

Описание

result
object | boolean

Привязки включаемых областей сайта в формате {"<ID_ОБЛАСТИ>": <ID_СТРАНИЦЫ>}.

Если для сайта сохранены привязки, метод возвращает объект. Если привязок нет, метод возвращает true (подробное описание)

time
time

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

Объект result

Название
тип

Описание

<ID_ОБЛАСТИ>
integer

Идентификатор включаемой области шаблона. Значение по этому ключу содержит идентификатор страницы, назначенной в эту область

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

HTTP-статус: 400

{
            "error": "ENTITY_NOT_FOUND",
            "error_description": "Сущность не найдена"
        }

Название
тип

Описание

error
string

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

error_description
error_description

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

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

Код

Описание

MISSING_PARAMS

Не передан обязательный параметр id

ENTITY_NOT_FOUND

Сайт не найден или недоступен

ACCESS_DENIED

Недостаточно прав для просмотра сайта

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

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

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

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

Предыдущая
Получить список включаемых областей для страницы
Следующая
Получить список шаблонов