landing.template.getLandingRef
Получить список включаемых областей для страницы
Описание
Метод landing.template.getLandingRef получает список включаемых областей, которые привязаны к странице.
В ответ входят только привязки, сохраненные для страницы. Привязки, которые настроены на уровне сайта, метод не возвращает. Чтобы получить их, используйте метод landing.template.getSiteRef.
Параметры
id
integer
обязательный
Идентификатор страницы.
Идентификатор страницы можно получить методом landing.landing.getList
Примеры запроса
curl -X POST \
-H "Content-Type: application/json" \
-d '{
"id": 557
}' \
"https://**put.your-domain-here**/rest/**user_id**/**webhook_code**/landing.template.getLandingRef.json"
curl -X POST \
-H "Content-Type: application/json" \
-d '{
"id": 557,
"auth": "**put_access_token_here**"
}' \
"https://**put.your-domain-here**/rest/landing.template.getLandingRef.json"
// 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 the payload returned in result (match the "response handling" section of the page)
type LandingRefResult = Record<string, number> | true
try {
const response = await $b24.actions.v2.call.make<LandingRefResult>({
method: 'landing.template.getLandingRef',
params: {
id: 557,
},
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
if (result === true) {
console.info('No landing refs configured')
} else {
console.info('Landing refs:', result, 'Area count:', Object.keys(result).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 getLandingRef() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'landing.template.getLandingRef',
params: {
id: 557,
},
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
if (result === true) {
console.info('No landing refs configured')
} else {
console.info('Landing refs:', result, 'Area count:', Object.keys(result).length)
}
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', getLandingRef)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.landing.template.get_landing_ref(
bitrix_id=557,
).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(
'landing.template.getLandingRef',
[
'id' => 557,
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . print_r($result, true);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error getting landing refs: ' . $e->getMessage();
}
BX24.callMethod(
'landing.template.getLandingRef',
{
id: 557
},
function(result)
{
if (result.error())
{
console.error(result.error());
}
else
{
console.info(result.data());
}
}
);
require_once('crest.php');
$result = CRest::call(
'landing.template.getLandingRef',
[
'id' => 557,
]
);
if (isset($result['error']))
{
echo 'Ошибка: ' . $result['error_description'];
}
else
{
echo '<pre>';
print_r($result['result']);
echo '</pre>';
}
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "landing.template.getLandingRef", b24.Params{
"id": 557,
})
if err != nil {
return fmt.Errorf("landing.template.getLandingRef: %w", err)
}
var item struct {
F1 int `json:"1"`
F2 int `json:"2"`
F3 int `json:"3"`
}
if err := json.Unmarshal(res.Result, &item); err != nil {
return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println(item.F1, item.F2)
Ответ
HTTP-статус: 200
{
"result": {
"1": 614,
"2": 615,
"3": 616
},
"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
Привязки включаемых областей страницы в формате {"<ID_ОБЛАСТИ>": <ID_СТРАНИЦЫ>}.
Если для страницы сохранены привязки, метод возвращает объект. Если привязок нет, метод возвращает true (подробное описание)
time
time
Информация о времени выполнения запроса
Обработка ошибок
HTTP-статус: 400
{
"error": "ENTITY_NOT_FOUND",
"error_description": "Сущность не найдена"
}
| Код | Описание | Значение |
|---|---|---|
MISSING_PARAMS |
Не передан обязательный параметр id |
|
ENTITY_NOT_FOUND |
Страница не найдена или недоступна | |
ACCESS_DENIED |
Недостаточно прав для просмотра сайта |

