Получить список шаблонов представления landing.template.getlist

Scope: landing

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

Метод landing.template.getlist получает список шаблонов представления текущего портала по параметрам выборки.

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

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

Название
тип

Описание

params
object

Объект параметров выборки шаблонов представления формата:

{
            "select": ["поле_1", "поле_2"],
            "filter": {
                "поле": "значение"
            },
            "order": {
                "поле": "ASC"
            },
            "group": ["поле"],
            "limit": 50,
            "offset": 0
        }

Список доступных полей описан ниже

Параметр params

Название
тип

Описание

select
string[]

Список полей из полей объекта Шаблон представления.

Если параметр не передан, метод возвращает все доступные поля шаблона.

Поля вида CREATED_BY.NAME не поддерживаются

filter
object

Фильтр по полям из полей объекта Шаблон представления.

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

Поля вида CREATED_BY.NAME не поддерживаются

order
object

Сортировка в формате {"FIELD": "ASC"} или {"FIELD": "DESC"}.

Можно передать несколько полей. Если параметр не передан, метод не задает собственную сортировку

group
array

Массив имен полей для группировки, например ["ACTIVE"] или ["ACTIVE", "SORT"].

Вычисляемые поля через runtime не поддерживаются

limit
integer

Максимальное количество элементов в ответе.

Если limit не указан, метод возвращает все найденные шаблоны без ограничения. Используйте вместе с offset для постраничной выборки

offset
integer

Смещение от начала выборки. Используйте вместе с limit для постраничной выборки

Примеры кода

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

curl -X POST \
          -H "Content-Type: application/json" \
          -d '{
            "params": {
              "select": [
                "ID",
                "TITLE",
                "XML_ID",
                "SORT",
                "ACTIVE",
                "DATE_MODIFY"
              ],
              "filter": {
                "=ACTIVE": "Y"
              },
              "order": {
                "SORT": "ASC",
                "ID": "ASC"
              },
              "limit": 2,
              "offset": 0
            }
          }' \
          "https://**put.your-domain-here**/rest/**user_id**/**webhook_code**/landing.template.getlist.json"
        
curl -X POST \
          -H "Content-Type: application/json" \
          -d '{
            "params": {
              "select": [
                "ID",
                "TITLE",
                "XML_ID",
                "SORT",
                "ACTIVE",
                "DATE_MODIFY"
              ],
              "filter": {
                "=ACTIVE": "Y"
              },
              "order": {
                "SORT": "ASC",
                "ID": "ASC"
              },
              "limit": 2,
              "offset": 0
            },
            "auth": "**put_access_token_here**"
          }' \
          "https://**put.your-domain-here**/rest/landing.template.getlist.json"
        
try
        {
            const response = await $b24.callMethod(
                'landing.template.getlist',
                {
                    params: {
                        select: [
                            'ID',
                            'TITLE',
                            'XML_ID',
                            'SORT',
                            'ACTIVE',
                            'DATE_MODIFY'
                        ],
                        filter: {
                            '=ACTIVE': 'Y'
                        },
                        order: {
                            SORT: 'ASC',
                            ID: 'ASC'
                        },
                        limit: 2,
                        offset: 0
                    }
                }
            );
        
            const result = response.getData().result;
            console.info(result);
        }
        catch (error)
        {
            console.error(error);
        }
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'landing.template.getlist',
                    [
                        'params' => [
                            'select' => [
                                'ID',
                                'TITLE',
                                'XML_ID',
                                'SORT',
                                'ACTIVE',
                                'DATE_MODIFY',
                            ],
                            'filter' => [
                                '=ACTIVE' => 'Y',
                            ],
                            'order' => [
                                'SORT' => 'ASC',
                                'ID' => 'ASC',
                            ],
                            'limit' => 2,
                            'offset' => 0,
                        ],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error getting template list: ' . $e->getMessage();
        }
        
BX24.callMethod(
            'landing.template.getlist',
            {
                params: {
                    select: [
                        'ID',
                        'TITLE',
                        'XML_ID',
                        'SORT',
                        'ACTIVE',
                        'DATE_MODIFY'
                    ],
                    filter: {
                        '=ACTIVE': 'Y'
                    },
                    order: {
                        SORT: 'ASC',
                        ID: 'ASC'
                    },
                    limit: 2,
                    offset: 0
                }
            },
            function(result)
            {
                if (result.error())
                {
                    console.error(result.error());
                }
                else
                {
                    console.info(result.data());
                }
            }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'landing.template.getlist',
            [
                'params' => [
                    'select' => [
                        'ID',
                        'TITLE',
                        'XML_ID',
                        'SORT',
                        'ACTIVE',
                        'DATE_MODIFY',
                    ],
                    'filter' => [
                        '=ACTIVE' => 'Y',
                    ],
                    'order' => [
                        'SORT' => 'ASC',
                        'ID' => 'ASC',
                    ],
                    'limit' => 2,
                    'offset' => 0,
                ],
            ]
        );
        
        if (isset($result['error']))
        {
            echo 'Ошибка: ' . $result['error_description'];
        }
        else
        {
            echo '<pre>';
            print_r($result['result']);
            echo '</pre>';
        }

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

HTTP-статус: 200

{
            "result": [
                {
                    "ID": "1",
                    "TITLE": "С шапкой и подвалом",
                    "XML_ID": "header_footer",
                    "SORT": "100",
                    "ACTIVE": "Y",
                    "DATE_MODIFY": "10/10/2022 03:25:30 pm"
                },
                {
                    "ID": "2",
                    "TITLE": "С сайдбаром слева",
                    "XML_ID": "sidebar_left",
                    "SORT": "200",
                    "ACTIVE": "Y",
                    "DATE_MODIFY": "10/10/2022 03:25:30 pm"
                }
            ],
            "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[]

Список шаблонов представления (подробное описание).

Если по фильтру ничего не найдено, метод возвращает result: []

time
time

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

Объект template

Название
тип

Описание

FIELD
string | integer | null

Поле шаблона представления из полей объекта Шаблон представления, если оно попало в выборку.

Для полей DATE_CREATE и DATE_MODIFY метод всегда возвращает строку, например 04/20/2020 12:48:10 pm

Особенности ответа:

  • Поле TITLE обычно возвращается как название на текущем языке портала
  • Если для системного шаблона не найден перевод, в TITLE может вернуться языковой ключ вида #...#, например #HEADER_ONLY#

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

HTTP-статус: 400

{
            "error": "ACCESS_DENIED",
            "error_description": "Недостаточно прав."
        }

Название
тип

Описание

error
string

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

error_description
error_description

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

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

Код

Описание

ACCESS_DENIED

Недостаточно прав для работы с разделом «Сайты и магазины»

TYPE_ERROR

Ошибка типа данных при обработке параметров вызова

SYSTEM_ERROR

Внутренняя ошибка при выполнении метода

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

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

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

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

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