From ISPWiki

Legend

- available in BILLmanager Standard - available in BILLmanager Advanced - available in BILLmanager Corporate

Contents 1 Partner 1.1 Customer 1.1.1 Users 1.2 Services 1.2.1 Domain names 1.3 Support 1.3.1 Categories 1.4 Directory 1.4.1 Top-level domains 1.5 Integration 1.5.1 Registrars

See also

• BILLmanager API/Provider
• BILLmanager API/Customer

Partner

Customer

Users

Function: user

Result: the list of elements

• id - .
• name - Username.
• realname - Full name.
• email - E-mail.
• disabled - Access denied.
• superuser - This user has superuser privileges .

Function: user.edit

The function is simultaneously used to view and change object's parameters.

View object's parameters:

• Parameters:
  • elid - unique identifier ("id" element of "user" function)
• Result: parameters list

Change an object:

• Parameters:
  • sok - the parameter must not be empty, generally "yes".
  • elid - unique identifier ("id" element of "user" function)
  • additional query parameters ...
• Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

Function: user.delete

Parameters:

• elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "id" element of "user" function.

Result: successful operation or error message

Function: user.enable

Parameters:

• elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "id" element of "user" function.

Result: successful operation or error message

Function: user.disable

Parameters:

• elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "id" element of "user" function.

Result: successful operation or error message

Function: user.contact

Parameters:

• elid - unique identifier ("id" element of "user" function).

Result: elements list

• id - .
• name - Contact.
• type - Type .

Function: user.contact.edit

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

• Parameters:
  • plid - parent list unique identifier ("id" element of "user" function).
  • elid - unique identifier ("id" element of "user.contact" function)
• Result: object parameters list

Create an object:

• Parameters:
  • sok - the parameter must not be empty, generally "yes".
  • plid - parent list unique identifier ("id" element of "user" function).
  • additional query parameters ...
• Result: successful operation or error message

Change an object:

• Parameters:
  • sok - the parameter must not be empty, generally "yes".
  • plid - parent list unique identifier ("id" element of "user" function).
  • elid - unique identifier ("id" element of "user.contact" function)
  • additional query parameters ...
• Result: successfull operation or error message

The list object's parameters or additional query parameters (see above):

• type - Type .
  If the 1 value is selected the parameters are allowed to use: 'mobile' and the parameters are denied: 'email','jabber'

• email - Email .
• mobile - Phone number .
• jabber - Jabber.

Function: user.contact.delete

Parameters:

• plid - parent list unique identifier ("id" element of "user" function).
• elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "id" element of "user.contact" function.

Result: successful operation or error message

Function: user.access

Parameters:

• elid - unique identifier ("id" element of "user" function).

Result: elements list

• ftitle - Name.
• name - Function.
• active - Granted .
• nochild - Does not effect child.

Function: user.access.enable

Parameters:

• plid - parent list unique identifier ("id" element of "user" function).
• elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "name" element of "user.access" function.

Result: successful operation or error message

Function: user.access.disable

Parameters:

• plid - parent list unique identifier ("id" element of "user" function).
• elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "name" element of "user.access" function.

Result: successful operation or error message

Function: user.setfilter

Services

Domain names

Function: domain

Result: the list of elements

• id - .
• name - Имя.
• expire - Дата окончания регистрации.
• autoperiod - Автопродление.
• domainstatus - Статус домена.
• unverified - Не заверен.
• processing - Документы отправлены.
• verified - Заверен.
• withdocs - Файлы прикреплены.

Function: domain.edit

The function is simultaneously used to view and change object's parameters.

View object's parameters:

• Parameters:
  • elid - unique identifier ("id" element of "domain" function)
• Result: parameters list

Change an object:

• Parameters:
  • sok - the parameter must not be empty, generally "yes".
  • elid - unique identifier ("id" element of "domain" function)
  • additional query parameters ...
• Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

• name - Доменное имя.
• tld - Доменная зона.
• idn - IDN.
• autoperiod - Автопродление.
• auth_code - Код подтверждения.
• note - Заметки.
• lowner - Владелец.
• ladmin - Администратор.
• ltech - Тех. поддержка.
• lbill - Фин. администратор.
• lnic - Анкета клиента.
• ns0 - NS1.
• ns1 - NS2.
• ns2 - NS3.
• ns3 - NS4.
• dopns - Дополнительные NS. (One or more values space-delimited)
• changens - . (Optional parameter. To enable the option click "on".)
• subjnic - Контракт.
• pwd - Административный пароль.
• tech_pwd - Технический пароль.

Function: domain.delete

Parameters:

• elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "id" element of "domain" function.

Result: successful operation or error message

Support

Categories

Function: supportcategories

Result: the list of elements

• id - .
• name - .
• department - Отдел по умолчанию.
• price - Цена.
• project - .
• enabled - Включено.

Function: supportcategories.edit

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

• Parameters:
  • elid - unique identifier ("id" element of "supportcategories" function)
• Result: object parameters list

Create an object:

• Parameters:
  • sok - the parameter must not be empty, generally "yes".
  • additional query parameters ...
• Result: successful operation or error message

Change an object:

• Parameters:
  • sok - the parameter must not be empty, generally "yes".
  • elid - unique identifier ("id" element of "supportcategories" function)
  • additional query parameters ...
• Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

• name - Название.
• department - Отдел по умолчанию.
• project - .
• pricelist - Категория запроса.
• fullaccess - Полный доступ. (Optional parameter. To enable the option click "on".)
• notification - Новостная категория. (Optional parameter. To enable the option click "on".)
• estimate - Оценивать. (Optional parameter. To enable the option click "on".)
• alert - Предупреждение.

Function: supportcategories.delete

Parameters:

• elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "id" element of "supportcategories" function.

Result: successful operation or error message

Function: supportcategories.enable

Parameters:

• elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "id" element of "supportcategories" function.

Result: successful operation or error message

Function: supportcategories.disable

Parameters:

• elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "id" element of "supportcategories" function.

Result: successful operation or error message

Function: supportcategoriesaccess

Parameters:

• elid - unique identifier ("id" element of "supportcategories" function).

Result: elements list

• name - Наименование типа продукта.
• enabled - Включено.
• pricelist - Категория доступна для отдельных тарифных планов.

Function: supportcategoriesaccess.enable

Parameters:

• plid - parent list unique identifier ("id" element of "supportcategories" function).
• elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "id" element of "supportcategoriesaccess" function.

Result: successful operation or error message

Function: supportcategoriesaccess.disable

Parameters:

• plid - parent list unique identifier ("id" element of "supportcategories" function).
• elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "id" element of "supportcategoriesaccess" function.

Result: successful operation or error message

Function: supportcategoriesaccess.pricelist

Parameters:

• elid - unique identifier ("id" element of "supportcategoriesaccess" function).

Result: elements list

• name - Наименование тарифного плана.
• enabled - Включено.

Function: supportcategoriesaccess.pricelist.enable

Parameters:

• plid - parent list unique identifier ("id" element of "supportcategoriesaccess" function).
• elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "id" element of "supportcategoriesaccess.pricelist" function.

Result: successful operation or error message

Function: supportcategoriesaccess.pricelist.disable

Parameters:

• plid - parent list unique identifier ("id" element of "supportcategoriesaccess" function).
• elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "id" element of "supportcategoriesaccess.pricelist" function.

Result: successful operation or error message

Directory

Top-level domains

Function: tld

Result: the list of elements

• id - .
• name - Название.
• registrar - Регистратор.

Function: tld.edit

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

• Parameters:
  • elid - unique identifier ("id" element of "tld" function)
• Result: object parameters list

Create an object:

• Parameters:
  • sok - the parameter must not be empty, generally "yes".
  • additional query parameters ...
• Result: successful operation or error message

Change an object:

• Parameters:
  • sok - the parameter must not be empty, generally "yes".
  • elid - unique identifier ("id" element of "tld" function)
  • additional query parameters ...
• Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

• name - Название.
• registrar - Регистратор.
• minlenght - Минимальная длина.
• isidn - IDN.
• isoneyear - Регистрация не более года. (Optional parameter. To enable the option click "on".)
• notransfermoney - Трансфер без продления. (Optional parameter. To enable the option click "on".)
• isverified - Верификация документов. (Optional parameter. To enable the option click "on".)
• whoishost - Имя хоста whois.
• wh_strnofound - Подстрока ответа whois.

Integration

Registrars

Function: registrar

Result: the list of elements

• id - .
• registrar - Название.
• balance - Баланс.

Function: registrar.edit

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

• Parameters:
  • elid - unique identifier ("id" element of "registrar" function)
• Result: object parameters list

Create an object:

• Parameters:
  • sok - the parameter must not be empty, generally "yes".
  • additional query parameters ...
• Result: successful operation or error message

Change an object:

• Parameters:
  • sok - the parameter must not be empty, generally "yes".
  • elid - unique identifier ("id" element of "registrar" function)
  • additional query parameters ...
• Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

• name - Название.
  If the directi value is selected the parameters are allowed to use: 'chbalance','url','usr','pwd','admgrp' and the parameters are denied: 'mangrp','test','isbonus','remark','nichandle','reg_mail','key','lang','curr','tech_mail','host','import'

• reg_mail - E-mail.
• host - Хост.
• url - URL-адрес.
• username - Имя пользователя.
• password - Пароль.
• private_key - Секретный ключ.
• currency - Валюта.
• msg_lang - Язык сообщений.
• nichandle - Ник-Хендл.
• dop_remark - Дополнительная информация.
• dop_isbonus - Бонусный счет. (Optional parameter. To enable the option click "on".)
• dop_test - Тестовый шлюз. (Optional parameter. To enable the option click "on".)
• admingroup - Ответственный отдел.
• issenderror - Отправлять ошибки. (Optional parameter. To enable the option click "on".)
• isbalance - . (Optional parameter. To enable the option click "on".)
  Active parameter allows the use of the following parameters: 'minbalance'

• minbalance - Минимальный баланс.
• manualgroup - Ответственный отдел.

Function: registrar.delete

Parameters:

• elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "id" element of "registrar" function.

Result: successful operation or error message

Function: registrar.importdomain

Parameters:

• elid - unique identifier ("id" element of "registrar" function).

Result: elements list

• name - Доменное имя.
• account - Владелец.
• expire - Дата окончания регистрации.
• domainstatus - Статус домена.
• yesdomain - Домен присутствует в системе.
• nodomain - Домен отсутствует в системе.
• notbigmatch - Серьезное несоответствие данных системы и регистратора.
• notmidimatch - Незначительное несоответствие данных системы и регистратора.

Function: registrar.importdomain.edit

• domain - Доменные имена. (One or more values space-delimited)

Function: importdomain.fixdomain

Parameters:

• plid - parent list unique identifier ("id" element of "registrar" function).
• elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "id" element of "registrar.importdomain" function.

Result: successful operation or error message

Function: registrar.domainprop

Parameters:

• elid - unique identifier ("id" element of "registrar.importdomain" function).

Result: elements list

• prop - Свойство.
• value - Значение у регистратора.
• thisvalue - Текущее значение.

Function: registrar.acc2domain.edit

Function: importhosting

---

• Use the "featurelist" API function to get the list of active features.