Получить список валют crm.currency.list
Scope:
crmКто может выполнять метод: любой пользователь с доступом к настройкам CRM
Метод получает список валют, созданных на портале.
Примечание
Параметры локализации (настройки, зависящие от языка) будут возвращены для текущего языка портала.
Параметры метода
|
Название |
Описание |
|
order |
Объект для сортировки записей в формате Возможные значения для
|
Примеры кода
Как использовать примеры в документации
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"order":{"sort":"asc","currency":"asc"}}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.currency.list
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"order":{"sort":"asc","currency":"asc"},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/crm.currency.list
// callListMethod: Получает все данные сразу. Используйте только для небольших выборок (< 1000 элементов) из-за высокой нагрузки на память.
try {
const response = await $b24.callListMethod(
'crm.currency.list',
{
order: {
sort: 'asc',
currency: 'asc',
},
}
);
const items = response.getData() || [];
for (const entity of items) {
console.log('Entity:', entity);
}
} catch (error) {
console.error('Request failed', error);
}
// fetchListMethod: Выбирает данные по частям с помощью итератора. Используйте для больших объемов данных для эффективного потребления памяти.
try {
const generator = $b24.fetchListMethod('crm.currency.list', {
order: {
sort: 'asc',
currency: 'asc',
},
}, 'ID');
for await (const page of generator) {
for (const entity of page) {
console.log('Entity:', entity);
}
}
} catch (error) {
console.error('Request failed', error);
}
// callMethod: Ручное управление постраничной навигацией через параметр start. Используйте для точного контроля над пакетами запросов. Для больших данных менее эффективен, чем fetchListMethod.
try {
const response = await $b24.callMethod('crm.currency.list', {
order: {
sort: 'asc',
currency: 'asc',
},
}, 0);
const result = response.getData().result || [];
for (const entity of result) {
console.log('Entity:', entity);
}
} catch (error) {
console.error('Request failed', error);
}
try {
$response = $b24Service
->core
->call(
'crm.currency.list',
[
'order' => [
'sort' => 'asc',
'currency' => 'asc',
],
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . print_r($result, true);
// Нужная вам логика обработки данных
processData($result);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error: ' . $e->getMessage();
}
BX24.callMethod(
"crm.currency.list",
{
order: {
sort: 'asc',
currency: 'asc',
},
},
)
.then(
function(result)
{
if (result.error())
{
console.error(result.error());
}
else
{
console.log(result.data);
}
},
function(error)
{
console.info(error);
}
);
require_once('crest.php');
$result = CRest::call(
'crm.currency.list',
[
'order' => [
'sort' => 'asc',
'currency' => 'asc',
]
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
Обработка ответа
HTTP-статус: 200
{
"result": [
{
"CURRENCY": "RUB",
"AMOUNT_CNT": "1",
"AMOUNT": "1.0000",
"SORT": "100",
"BASE": "Y",
"FULL_NAME": "Российский рубль",
"LID": "ru",
"FORMAT_STRING": "# ₽",
"DEC_POINT": ".",
"THOUSANDS_SEP": " ",
"DECIMALS": "2",
"DATE_UPDATE": "2024-01-29T12:28:40+02:00"
},
{
"CURRENCY": "USD",
"AMOUNT_CNT": "1",
"AMOUNT": "68.7900",
"SORT": "200",
"BASE": "N",
"FULL_NAME": "Доллар США",
"LID": "ru",
"FORMAT_STRING": "$#",
"DEC_POINT": ".",
"THOUSANDS_SEP": null,
"DECIMALS": "2",
"DATE_UPDATE": "2023-03-21T15:19:50+02:00"
},
{
"CURRENCY": "EUR",
"AMOUNT_CNT": "1",
"AMOUNT": "78.3200",
"SORT": "300",
"BASE": "N",
"FULL_NAME": "Евро",
"LID": "ru",
"FORMAT_STRING": "# €",
"DEC_POINT": ".",
"THOUSANDS_SEP": " ",
"DECIMALS": "2",
"DATE_UPDATE": "2023-03-21T15:19:50+02:00"
},
{
"CURRENCY": "BYN",
"AMOUNT_CNT": "1",
"AMOUNT": "32.2000",
"SORT": "500",
"BASE": "N",
"FULL_NAME": "Белорусский рубль",
"LID": "ru",
"FORMAT_STRING": "# руб.",
"DEC_POINT": ".",
"THOUSANDS_SEP": " ",
"DECIMALS": "2",
"DATE_UPDATE": "2023-03-21T15:19:50+02:00"
},
],
"total": 0,
"time": {
"start": 1716986687.629166,
"finish": 1716986688.481436,
"duration": 0.8522701263427734,
"processing": 0.014969825744628906,
"date_start": "2024-05-29T14:44:47+02:00",
"date_finish": "2024-05-29T14:44:48+02:00",
"operating": 0
}
}
Возвращаемые данные
|
Название |
Описание |
|
result |
Массив объектов с информацией о выбранных валютах |
|
total |
На текущий момент всегда имеет значение |
|
time |
Информация о времени выполнения запроса |
Обработка ошибок
HTTP-статус: 400
{
"error": "",
"error_description": "Access denied."
}
|
Название |
Описание |
|
error |
Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания |
|
error_description |
Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде |
Возможные коды ошибок
|
Код |
Описание |
Значение |
|
Пустая строка |
Access denied. |
Недостаточно прав доступа |
|
Пустая строка |
Failed to get list. General error. |
Не установлен модуль currency (валюты) |
Статусы и коды системных ошибок
HTTP-статус: 20x, 40x, 50x
Описанные ниже ошибки могут возникнуть при вызове любого метода
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Текущий метод не разрешен для вызова с помощью batch |
|
|
|
Превышена максимальная длина параметров, переданных в метод batch |
|
|
|
Неверный access-токен или код вебхука |
|
|
|
Для вызовов методов требуется использовать протокол HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих планах |
|
|
|
У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав |
|
|
|
Манифест недоступен |
|
|
|
Запрос требует более высоких привилегий, чем предоставляет токен вебхука |
|
|
|
Предоставленный access-токен доступа истек |
|
|
|
Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |
Продолжите изучение
- Добавить валюту crm.currency.add
- Обновить валюту crm.currency.update
- Получить валюту по id crm.currency.get
- Удалить валюту crm.currency.delete
- Получить поля валюты crm.currency.fields