Установить локализации для валюты crm.currency.localizations.set

Scope: crm

Кто может выполнять метод: любой пользователь с доступом к изменению настроек CRM

Метод обновляет локализации для валюты или добавляет, если локализация для указанного языка не существует.

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

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

Название /
тип

Описание

id*
string

Идентификатор валюты.

Соответствует стандарту ISO 4217.

Идентификатор можно получить методом crm.currency.list

localizations*
object

Параметры локализации валюты.
Объект в формате {"lang_1": "value_1", ... "lang_N": "value_N"}, где lang_N — идентификатор языка, для которого надо добавить/изменить локализацию, а value — объект типа crm_currency_localization.

Существующие локализации, которые не переданы в метод, не будут изменены.

Примеры кода

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

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"id":"CLF","localizations":{"en":{"FULL_NAME":"Unidad de Fomento","FORMAT_STRING":"CLF#VALUE#","DEC_POINT":".","THOUSANDS_VARIANT":"C","DECIMALS":4},"ru":{"FULL_NAME":"Единица развития","FORMAT_STRING":"#VALUE# CLF","DEC_POINT":".","THOUSANDS_VARIANT":"B","DECIMALS":4}}}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.currency.localizations.set
        
curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"id":"CLF","localizations":{"en":{"FULL_NAME":"Unidad de Fomento","FORMAT_STRING":"CLF#VALUE#","DEC_POINT":".","THOUSANDS_VARIANT":"C","DECIMALS":4},"ru":{"FULL_NAME":"Единица развития","FORMAT_STRING":"#VALUE# CLF","DEC_POINT":".","THOUSANDS_VARIANT":"B","DECIMALS":4}},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/crm.currency.localizations.set
        
try
        {
        	const response = await $b24.callMethod(
        		"crm.currency.localizations.set",
        		{
        			id: 'CLF',
        			localizations: {
        				en: {
        					FULL_NAME: 'Unidad de Fomento',
        					FORMAT_STRING: 'CLF#VALUE#',
        					DEC_POINT: '.',
        					THOUSANDS_VARIANT: 'C',
        					DECIMALS: 4,
        				},
        				ru: {
        					FULL_NAME: 'Единица развития',
        					FORMAT_STRING: '#VALUE# CLF',
        					DEC_POINT: '.',
        					THOUSANDS_VARIANT: 'B',
        					DECIMALS: 4,
        				}
        			}
        		}
        	);
        	
        	const result = response.getData().result;
        	console.log(result);
        }
        catch( error )
        {
        	console.error(error);
        }
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'crm.currency.localizations.set',
                    [
                        'id' => 'CLF',
                        'localizations' => [
                            'en' => [
                                'FULL_NAME'        => 'Unidad de Fomento',
                                'FORMAT_STRING'    => 'CLF#VALUE#',
                                'DEC_POINT'        => '.',
                                'THOUSANDS_VARIANT' => 'C',
                                'DECIMALS'         => 4,
                            ],
                            'ru' => [
                                'FULL_NAME'        => 'Единица развития',
                                'FORMAT_STRING'    => '#VALUE# CLF',
                                'DEC_POINT'        => '.',
                                'THOUSANDS_VARIANT' => 'B',
                                'DECIMALS'         => 4,
                            ],
                        ],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error setting currency localizations: ' . $e->getMessage();
        }
        
BX24.callMethod(
            "crm.currency.localizations.set",
            {
                id: 'CLF',
                localizations: {
                    en: {
                        FULL_NAME: 'Unidad de Fomento',
                        FORMAT_STRING: 'CLF#VALUE#',
                        DEC_POINT: '.',
                        THOUSANDS_VARIANT: 'C',
                        DECIMALS: 4,
                    },
                    ru: {
                        FULL_NAME: 'Единица развития',
                        FORMAT_STRING: '#VALUE# CLF',
                        DEC_POINT: '.',
                        THOUSANDS_VARIANT: 'B',
                        DECIMALS: 4,
                    }
                }
            },
        )
        .then(
            function(result)
            {
                if (result.error())
                {
                    console.error(result.error());
                }
                else
                {
                    console.log(result);
                }
            },
            function(error)
            {
                console.info(error);
            }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'crm.currency.localizations.set',
            [
                'id' => 'CLF',
                'localizations' => [
                    'en' => [
                        'FULL_NAME' => 'Unidad de Fomento',
                        'FORMAT_STRING' => 'CLF#VALUE#',
                        'DEC_POINT' => '.',
                        'THOUSANDS_VARIANT' => 'C',
                        'DECIMALS' => 4,
                    ],
                    'ru' => [
                        'FULL_NAME' => 'Единица развития',
                        'FORMAT_STRING' => '#VALUE# CLF',
                        'DEC_POINT' => '.',
                        'THOUSANDS_VARIANT' => 'B',
                        'DECIMALS' => 4,
                    ]
                ]
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';
        

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

HTTP-статус: 200

{
            "result": true,
            "time": {
                "start": 1718122481.837301,
                "finish": 1718122483.141736,
                "duration": 1.3044350147247314,
                "processing": 0.08866286277770996,
                "date_start": "2024-06-11T18:14:41+02:00",
                "date_finish": "2024-06-11T18:14:43+02:00",
                "operating": 0
            }
        }
        

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

Название
тип

Описание

result
boolean

Возвращает:

  • true — в случае успеха
  • false – в случае, когда операцию выполнить не удалось, но ошибки нет, либо ситуация не считается ошибочной. Возможные варианты:
    • отсутствует модуль валют
    • передан пустой объект с локализациями
    • не была добавлена/изменена ни одна локализация

time
time

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

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

HTTP-статус: 400

{
            "error": "",
            "error_description": "The parameter id is invalid or not defined."
        }
        

Название
тип

Описание

error
string

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

error_description
error_description

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

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

Код

Описание

Значение

Пустая строка

Access denied.

Недостаточно прав доступа

Пустая строка

The parameter id is invalid or not defined.

Пустой идентификатор валюты

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

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

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

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