Страны (country)

country

Результат: список элементов

Страны

Уровень доступа: admin

Параметр	Значение
id	Id
locale_name	Наименование
iso2	ISO2
phonecode	Телефонный код
status	Состояние

Страна

Функция: country.edit

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

Параметры:
- elid — уникальный идентификатор (элемент id из функции country)
Результат: список параметров объекта

Создание объекта:

Параметры:
- sok — значение параметра должно быть не пустым, обычно "ok".
- дополнительные параметры запроса ...
Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта

Параметры:
- sok — значение параметра должно быть не пустым, обычно "ok".
- elid — уникальный идентификатор (элемент id из функции country)
- дополнительные параметры запроса ...
Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см. выше):

Параметр	Значение
name	Наименование страны
iso2	ISO2. Двух или пяти-буквенный код страны или региона
phonecode	Телефонный код страны
phoneformat	Формат номера телефона задается при помощи маски, без указания телефонного кода. Символ '9' в маске обозначает цифру от 0 до 9. В квадратных скобках можно указать количество необязательных знаков. Например, при маске 99-99-99 телефон может состоять из пяти или из шести цифр без учета кода.
doctype	Типы документов доступные для компаний из этой страны

Регионы

Функция: country.state

Результат: список элементов

Уровень доступа: admin

Параметр	Значение
id	Id
locale_name	Наименование
iso	ISO код

Удалить

Функция: country.state.delete

Уровень доступа: admin

Параметры:

elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции country.state.

Результат: успешное выполнение операции или сообщение об ошибке

Редактирование региона

Функция: country.state.edit

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта. Просмотр параметров объекта:

Параметры:
- plid — уникальный идентификатор родительского списка (элемент id из функции country).
- elid — уникальный идентификатор (элемент id из функции country.state)
Результат: список параметров объекта

Создание объекта:

Параметры:
- sok — значение параметра должно быть не пустым, обычно "ok".
- plid — уникальный идентификатор родительского списка (элемент id из функции country).
- дополнительные параметры запроса ...
Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта:

Параметры:
- sok — значение параметра должно быть не пустым, обычно "ok".
- plid — уникальный идентификатор родительского списка (элемент id из функции country).
- elid — уникальный идентификатор (элемент id из функции country.state)
- дополнительные параметры запроса ...
Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см. выше):

Параметр	Значение
name	Наименование региона
iso	ISO код региона

Выключить

Функция: country.suspend

Уровень доступа: admin

Параметры:

elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции country.

Результат: успешное выполнение операции или сообщение об ошибке

Удалить

Функция: country.delete

Уровень доступа: admin

Параметры:

elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции country.

Результат: успешное выполнение операции или сообщение об ошибке

Параметры плательщиков и компаний

Функция: country.profileparam

Результат: список элементов

Уровень доступа: admin

Параметр	Значение
id	Id
locale_name	Наименование
profiletype	Статус плательщика
page	Блок
locale_hint	Описание
orderpriority	Сортировка (в прямом порядке)
props	Свойства

Переместить на одну позицию вверх

Функция: country.profileparam.up

Уровень доступа: admin

Включить

Функция: country.profileparam.resume

Уровень доступа: admin

Параметры:

elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции country.profileparam.

Результат: успешное выполнение операции или сообщение об ошибке

Переместить на одну позицию вниз

Функция: country.profileparam.down

Уровень доступа: admin

Удалить

Функция: country.profileparam.delete

Уровень доступа: admin

Параметры:

elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции country.profileparam.

Результат: успешное выполнение операции или сообщение об ошибке

Сброс настроек параметров плательщиков и компаний

Функция: country.profileparam.restoredefault

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта. Просмотр параметров объекта:

Параметры:
- plid — уникальный идентификатор родительского списка (элемент id из функции country).
- elid — уникальный идентификатор (элемент id из функции country.profileparam)
Результат: список параметров объекта

Создание объекта:

Параметры:
- sok — значение параметра должно быть не пустым, обычно "ok".
- plid — уникальный идентификатор родительского списка (элемент id из функции country).
- дополнительные параметры запроса ...
Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта:

Параметры:
- sok — значение параметра должно быть не пустым, обычно "ok".
- plid — уникальный идентификатор родительского списка (элемент id из функции country).
- elid — уникальный идентификатор (элемент id из функции country.profileparam)
- дополнительные параметры запроса ...
Результат: успешное выполнение операции или сообщение об ошибке

Выключить

Функция: country.profileparam.suspend

Уровень доступа: admin

Параметры:

elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции country.profileparam.

Результат: успешное выполнение операции или сообщение об ошибке

Параметр

Функция: country.profileparam.edit

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта. Просмотр параметров объекта:

Параметры:
- plid — уникальный идентификатор родительского списка (элемент id из функции country).
- elid — уникальный идентификатор (элемент id из функции country.profileparam)
Результат: список параметров объекта

Создание объекта:

Параметры:
- sok — значение параметра должно быть не пустым, обычно "ok".
- plid — уникальный идентификатор родительского списка (элемент id из функции country).
- дополнительные параметры запроса ...
Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта:

Параметры:
- sok — значение параметра должно быть не пустым, обычно "ok".
- plid — уникальный идентификатор родительского списка (элемент id из функции country).
- elid — уникальный идентификатор (элемент id из функции country.profileparam)
- дополнительные параметры запроса ...
Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см. выше):

Параметр	Значение
name	Наименование параметра
hint	Подсказка
intname	Внутреннее наименование параметра. Значение должно быть уникальным
page	Блок. В каком информационном блоке будет находиться это поле
inputtype	Тип поля ввода. Укажите данные какого типа будут вводиться в поле
required	(Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Запретить пустое значение для параметра
manual_validate_not_required	(Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Флаг отключает требование заполнения параметра для ручной верификации плательщика
profiletype	Статус плательщика. Параметр будет доступен для выбранных типов плательщиков
orderpriority	Сортировка (в прямом порядке). Позволяет задать приоритет поля при сортировке
readonly_client	(Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Установите флаг, если необходимо запретить изменение значения поля клиентом, после того как он уже совершил платеж
requiredonpay	На шаге оплаты. Выберите политику отображения поля при оплате на шаге заполнения информации о плательщике. Если не настроено, то отображение поля будет зависеть от встроенных в BILLmanager настроек
inputtype	Тип поля ввода. Укажите данные какого типа будут вводиться в поле
zoom	(Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Опция включает возможность ввода нескольких значений, разделенных пробелом. Выбранный валидатор будет применен к каждому значению в отдельности
inputrows	Количество строк ввода. Укажите количество строк ввода в текстовом поле
required	(Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Запретить пустое значение для параметра
validator	Функция проверки введенного значения. Это не позволит пользователю ввести значение в неправильном формате
select_ip	Тип IP-адреса
num_range	(Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Диапазон допустимых значений
r_start_int	Начальное значение диапазона
r_end_int	Конечное значение диапазона
r_start_float	Начальное значение диапазона
r_end_float	Конечное значение диапазона

Включить

Функция: country.resume

Уровень доступа: admin

Параметры:

elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции country.

Результат: успешное выполнение операции или сообщение об ошибке