Страны (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 код. 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.
Результат: успешное выполнение операции или сообщение об ошибке