documentgenerator.region.get
Получить регион по идентификатору
Описание
Метод documentgenerator.region.get возвращает данные региона по идентификатору или коду.
Параметры
id
string
обязательный
Идентификатор пользовательского региона или код предустановленного региона, например, ru.
Получить идентификатор можно после создания региона или методом получения списка регионов
Примеры запроса
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":"1"}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/documentgenerator.region.get
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":"1","auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/documentgenerator.region.get
// 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 RegionGetResult = {
region: {
id: string
title: string
languageId: string
formatDate: string
formatDatetime: string
formatName: string
phrases: Record<string, string>
}
}
try {
const response = await $b24.actions.v2.call.make<RegionGetResult>({
method: 'documentgenerator.region.get',
params: {
id: '1',
},
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
console.info(result.region.id, result.region.title, result.region.languageId)
}
} 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 getRegion() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'documentgenerator.region.get',
params: {
id: '1',
},
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
console.info(result.region.id, result.region.title, result.region.languageId)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', getRegion)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.documentgenerator.region.get(
bitrix_id=1,
).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(
'documentgenerator.region.get',
[
'id' => '1',
]
);
$result = $response->getResponseData()->getResult();
print_r($result);
} catch (Throwable $e) {
echo $e->getMessage();
}
BX24.callMethod(
'documentgenerator.region.get',
{
id: '1'
},
function(result)
{
if (result.error())
{
console.error(result.error());
}
else
{
console.log(result.data());
}
}
);
require_once('crest.php');
$result = CRest::call(
'documentgenerator.region.get',
[
'id' => '1',
]
);
print_r($result);
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "documentgenerator.region.get", b24.Params{
"id": "1",
}, b24.WithIdempotent())
if err != nil {
return fmt.Errorf("documentgenerator.region.get: %w", err)
}
// Метод заворачивает ответ в объект с ключом "region".
raw, ok := b24.Unwrap(res.Result, "region")
if !ok {
return fmt.Errorf("в ответе нет ключа region")
}
var item struct {
ID b24.ID `json:"id"`
Title string `json:"title"`
LanguageID string `json:"languageId"`
FormatDate string `json:"formatDate"`
FormatDatetime string `json:"formatDatetime"`
FormatName string `json:"formatName"`
}
if err := json.Unmarshal(raw, &item); err != nil {
return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println(item.ID, item.Title)
Ответ
HTTP-статус: 200
{
"result": {
"region": {
"id": "1",
"title": "Россия (Пользовательский)",
"languageId": "ru",
"formatDate": "YYYY-MM-DD",
"formatDatetime": "DD.MM.YYYY HH:MI:SS",
"formatName": "#LAST_NAME# #NAME# #SECOND_NAME#",
"phrases": {
"TAX_INCLUDED": "Налог включен в цену",
"TAX_NOT_INCLUDED": "НДС не включен в цену"
}
}
},
"time": {
"start": 1774505900,
"finish": 1774505900.746113,
"duration": 0.7461130619049072,
"processing": 0,
"date_start": "2026-03-26T09:18:20+03:00",
"date_finish": "2026-03-26T09:18:20+03:00",
"operating_reset_at": 1774506500,
"operating": 0
}
}
Возвращаемые данные
result
object
Корневой элемент ответа (подробное описание)
time
time
Информация о времени выполнения запроса
Обработка ошибок
HTTP-статус: 400
{
"error": "0",
"error_description": "Регион не найден"
}
| Код | Описание | Значение |
|---|---|---|
400 |
100 |
Could not find value for parameter {id} |
400 |
0 |
Регион не найден |
400 |
0 |
You do not have permissions to modify templates |

