BILLmanager API/Provider
From ISPWiki
| Legend |
See also
Provider
Provider
Projects
Function: project
Result: the list of elements
- id - .
- name - .
- site - Web-site.
- currency - Base currency.
Function: project.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 "project" 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 "project" function)
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
Function: project.delete
Parameters:
- elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "id" element of "project" function.
Result: successful operation or error message
Function: project.company
Parameters:
- elid - unique identifier ("id" element of "project" function).
Result: elements list
- id - .
- name - Company.
- active - The company is active.
Function: project.company.edit
The function is simultaneously used to view and change object's parameters.
View objects parameters:
- Parameters:
- plid - parent list unique identifier ("id" element of "project" function).
- elid - unique identifier ("id" element of "project.company" function)
- Result: parameters list
Change an object:
- Parameters:
- sok - the parameter must not be empty, generally "yes".
- plid - parent list unique identifier ("id" element of "project" function).
- elid - unique identifier ("id" element of "project.company" function)
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
- paydesc - Payment destination .
- active - Active . (Optional parameter. To enable the option click "on".)
Function: project.company.enable
Parameters:
- plid - parent list unique identifier ("id" element of "project" function).
- elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "id" element of "project.company" function.
Result: successful operation or error message
Function: project.company.disable
Parameters:
- plid - parent list unique identifier ("id" element of "project" function).
- elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "id" element of "project.company" function.
Result: successful operation or error message
Function: project.paymethod
Parameters:
- elid - unique identifier ("id" element of "project" function).
Result: elements list
- id - .
- name - Payment method.
- active - This payment method is active .
Function: project.paymethod.enable
Parameters:
- plid - parent list unique identifier ("id" element of "project" function).
- elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "id" element of "project.paymethod" function.
Result: successful operation or error message
Function: project.paymethod.disable
Parameters:
- plid - parent list unique identifier ("id" element of "project" function).
- elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "id" element of "project.paymethod" function.
Result: successful operation or error message
Companies
Function: company
Result: the list of elements
- id - .
- name - .
Function: company.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 "company" 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 "company" function)
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
Function: company.delete
Parameters:
- elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "id" element of "company" function.
Result: successful operation or error message
Function: company.project
Parameters:
- elid - unique identifier ("id" element of "company" function).
Result: elements list
- id - .
- name - Project.
- active - Project is active.
Function: company.project.enable
Parameters:
- plid - parent list unique identifier ("id" element of "company" function).
- elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "id" element of "company.project" function.
Result: successful operation or error message
Function: company.project.disable
Parameters:
- plid - parent list unique identifier ("id" element of "company" function).
- elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "id" element of "company.project" function.
Result: successful operation or error message
Function: company.paymethod
Parameters:
- elid - unique identifier ("id" element of "company" function).
Result: elements list
- id - .
- name - .
- module - Payment method.
- currency - Сurrency.
- priority - Priority.
- active - Available for clients.
Function: company.paymethod.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 "company" function).
- elid - unique identifier ("id" element of "company.paymethod" 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 "company" 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 "company" function).
- elid - unique identifier ("id" element of "company.paymethod" function)
- additional query parameters ...
- Result: successfull operation or error message
The list object's parameters or additional query parameters (see above):
- name - .
- currency - Сurrency.
- module - Payment method.
- active - Activate after creation. (Optional parameter. To enable the option click "on".)
- allproj - Allow for all projects. (Optional parameter. To enable the option click "on".)
Function: company.paymethod.delete
Parameters:
- plid - parent list unique identifier ("id" element of "company" function).
- elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "id" element of "company.paymethod" function.
Result: successful operation or error message
Function: company.paymethod.enable
Parameters:
- plid - parent list unique identifier ("id" element of "company" function).
- elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "id" element of "company.paymethod" function.
Result: successful operation or error message
Function: company.paymethod.disable
Parameters:
- plid - parent list unique identifier ("id" element of "company" function).
- elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "id" element of "company.paymethod" function.
Result: successful operation or error message
Function: company.contract
Parameters:
- elid - unique identifier ("id" element of "company" function).
Result: elements list
- id - .
- name - .
- servicekind - Kind of service.
- accountgroup - Account group.
- ptype - Payer status .
- templ - Template.
Function: company.contract.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 "company" function).
- elid - unique identifier ("id" element of "company.contract" 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 "company" 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 "company" function).
- elid - unique identifier ("id" element of "company.contract" function)
- additional query parameters ...
- Result: successfull operation or error message
The list object's parameters or additional query parameters (see above):
- name - .
- servicekind - Kind of service.
- accountgroup - Account group.
- ptype - Payer status .
- templ - Template.
- suffix - Suffix in the contract number.
- firstappendix - First appendix number.
Function: company.contract.delete
Parameters:
- plid - parent list unique identifier ("id" element of "company" function).
- elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "id" element of "company.contract" function.
Result: successful operation or error message
Function: company.contract.appendix
Parameters:
- elid - unique identifier ("id" element of "company.contract" function).
Result: elements list
- id - .
- name - .
- project - .
- itemtype - Item type.
- templ - Template.
Function: company.contract.appendix.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 "company.contract" function).
- elid - unique identifier ("id" element of "company.contract.appendix" 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 "company.contract" 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 "company.contract" function).
- elid - unique identifier ("id" element of "company.contract.appendix" function)
- additional query parameters ...
- Result: successfull operation or error message
The list object's parameters or additional query parameters (see above):
- name - .
- project - .
- itemtype - Item type.
- templ - Template.
Function: company.contract.appendix.delete
Parameters:
- plid - parent list unique identifier ("id" element of "company.contract" function).
- elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "id" element of "company.contract.appendix" function.
Result: successful operation or error message
Function: company.taxrule
Parameters:
- elid - unique identifier ("id" element of "company" function).
Result: elements list
- id - .
- country - Payer's country.
- taxrate - Tax rate.
Function: company.taxrule.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 "company" function).
- elid - unique identifier ("id" element of "company.taxrule" 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 "company" 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 "company" function).
- elid - unique identifier ("id" element of "company.taxrule" function)
- additional query parameters ...
- Result: successfull operation or error message
The list object's parameters or additional query parameters (see above):
- country - Payer's country.
- taxrate - Tax rate.
Function: company.taxrule.delete
Parameters:
- plid - parent list unique identifier ("id" element of "company" function).
- elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "id" element of "company.taxrule" function.
Result: successful operation or error message
Function: company.condition
Parameters:
- elid - unique identifier ("id" element of "company" function).
Result: elements list
- id - .
- country - Country.
- ptype - Type.
Function: company.condition.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 "company" function).
- elid - unique identifier ("id" element of "company.condition" 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 "company" 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 "company" function).
- elid - unique identifier ("id" element of "company.condition" function)
- additional query parameters ...
- Result: successfull operation or error message
The list object's parameters or additional query parameters (see above):
- countrycondition - Condition (country).
- country - Country.
- ptypeval - Customer's status .
Function: company.condition.delete
Parameters:
- plid - parent list unique identifier ("id" element of "company" function).
- elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "id" element of "company.condition" function.
Result: successful operation or error message
Function: company.condition.apply
Payment methods
Function: company.paymethod
Result: the list of elements
- id - .
- name - .
- module - Payment method.
- currency - Сurrency.
- priority - Priority.
- active - Available for clients.
Function: company.paymethod.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 "company.paymethod" 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 "company.paymethod" function)
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
- name - .
- currency - Сurrency.
- module - Payment method.
- active - Activate after creation. (Optional parameter. To enable the option click "on".)
- allproj - Allow for all projects. (Optional parameter. To enable the option click "on".)
Function: company.paymethod.delete
Parameters:
- elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "id" element of "company.paymethod" function.
Result: successful operation or error message
Function: company.paymethod.enable
Parameters:
- elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "id" element of "company.paymethod" function.
Result: successful operation or error message
Function: company.paymethod.disable
Parameters:
- elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "id" element of "company.paymethod" function.
Result: successful operation or error message
Departments
Function: admingroup
Result: the list of elements
- id - .
- name - .
Function: admingroup.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 "admingroup" 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 "admingroup" function)
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
- name - .
- lang - Language.
- chief - Department head .
- support - Support center group. (Optional parameter. To enable the option click "on".)
- remotesupport - Remote department . (Optional parameter. To enable the option click "on".) The parameter may vary depending on feature svrrsupport.
- note - Notes .
Function: admingroup.delete
Parameters:
- elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "id" element of "admingroup" function.
Result: successful operation or error message
Function: admingroup.workingtime
The function is simultaneously used to view and change object's parameters.
View object's parameters:
- Parameters:
- elid - unique identifier ("id" element of "admingroup" function)
- Result: parameters list
Change an object:
- Parameters:
- sok - the parameter must not be empty, generally "yes".
- elid - unique identifier ("id" element of "admingroup" function)
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
Function: admingroup.member
Parameters:
- elid - unique identifier ("id" element of "admingroup" function).
Result: elements list
- id - .
- name - Administrator .
- realname - Full name.
- active - Enabled.
Function: admingroup.member.enable
Parameters:
- plid - parent list unique identifier ("id" element of "admingroup" function).
- elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "id" element of "admingroup.member" function.
Result: successful operation or error message
Function: admingroup.member.disable
Parameters:
- plid - parent list unique identifier ("id" element of "admingroup" function).
- elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "id" element of "admingroup.member" function.
Result: successful operation or error message
Function: admingroup.project
Parameters:
- elid - unique identifier ("id" element of "admingroup" function).
Result: elements list
- id - .
- name - Project.
- active - Enabled .
Function: admingroup.project.enable
Parameters:
- plid - parent list unique identifier ("id" element of "admingroup" function).
- elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "id" element of "admingroup.project" function.
Result: successful operation or error message
Function: admingroup.project.disable
Parameters:
- plid - parent list unique identifier ("id" element of "admingroup" function).
- elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "id" element of "admingroup.project" function.
Result: successful operation or error message
Function: admingroup.access
Parameters:
- elid - unique identifier ("id" element of "admingroup" function).
Result: elements list
- ftitle - Name.
- name - Function.
- active - Enabled.
- nochild - Does not affect child.
Function: admingroup.access.enable
Parameters:
- plid - parent list unique identifier ("id" element of "admingroup" function).
- elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "name" element of "admingroup.access" function.
Result: successful operation or error message
Function: admingroup.access.disable
Parameters:
- plid - parent list unique identifier ("id" element of "admingroup" function).
- elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "name" element of "admingroup.access" function.
Result: successful operation or error message
Administrators
Function: admin
Result: the list of elements
- id - .
- name - User name.
- realname - Real name.
- email - E-mail.
- disabled - Access disabled.
- superuser - Administrator has superuser privileges .
Function: admin.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 "admin" 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 "admin" function)
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
- name - Username.
- realname - Real name.
- email - E-mail.
- phone - Phone number . The parameter may vary depending on feature svrsmsservice.
- sendsms - . (Optional parameter. To enable the option click "on".) The parameter may vary depending on feature svrsmsservice. Active parameter allows the use of the following parameters: 'smstime'
- smstimefrom - Time . The parameter may vary depending on feature svrsmsservice.
- smstimeto - Time . The parameter may vary depending on feature svrsmsservice.
- passwd - Password.
- confirm - Re-type password .
- superuser - Full access. (Optional parameter. To enable the option click "on".)
- disabled - Deny access. (Optional parameter. To enable the option click "on".)
Function: admin.delete
Parameters:
- elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "id" element of "admin" function.
Result: successful operation or error message
Function: admin.group
Parameters:
- elid - unique identifier ("id" element of "admin" function).
Result: elements list
- id - .
- name - Department name.
- active - Enabled.
Function: admin.group.enable
Parameters:
- plid - parent list unique identifier ("id" element of "admin" function).
- elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "id" element of "admin.group" function.
Result: successful operation or error message
Function: admin.group.disable
Parameters:
- plid - parent list unique identifier ("id" element of "admin" function).
- elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "id" element of "admin.group" function.
Result: successful operation or error message
Function: admin.project
Parameters:
- elid - unique identifier ("id" element of "admin" function).
Result: elements list
- id - .
- name - Project.
- active - Allowed .
Function: admin.project.enable
Parameters:
- plid - parent list unique identifier ("id" element of "admin" function).
- elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "id" element of "admin.project" function.
Result: successful operation or error message
Function: admin.project.disable
Parameters:
- plid - parent list unique identifier ("id" element of "admin" function).
- elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "id" element of "admin.project" function.
Result: successful operation or error message
Function: admin.access
Parameters:
- elid - unique identifier ("id" element of "admin" function).
Result: elements list
- ftitle - Name.
- name - Function.
- active - Enabled.
- nochild - Does not affect a child.
Function: admin.access.enable
Parameters:
- plid - parent list unique identifier ("id" element of "admin" function).
- elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "name" element of "admin.access" function.
Result: successful operation or error message
Function: admin.access.disable
Parameters:
- plid - parent list unique identifier ("id" element of "admin" function).
- elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "name" element of "admin.access" function.
Result: successful operation or error message
Function: admin.enable
Parameters:
- elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "id" element of "admin" function.
Result: successful operation or error message
Function: admin.disable
Parameters:
- elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "id" element of "admin" function.
Result: successful operation or error message
Function: admin.su
Partners
Function: partner
Result: the list of elements
- id - .
- name - .
Function: partner.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 "partner" 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 "partner" function)
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
- username - Имя пользователя.
- userid - Имя пользователя.
- passwd - Пароль.
- confirm - Подтверждение пароля.
- email - Электронная почта.
- person - Контактное лицо.
- projectname - Название проекта.
- projectid - Название проекта.
- site - Сайт.
- domain - Доменное имя билинга.
- currency - Валюта учета.
- note - .
Function: partner.delete
Parameters:
- elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "id" element of "partner" function.
Result: successful operation or error message
Function: partner.categories
Parameters:
- elid - unique identifier ("id" element of "partner" function).
Result: elements list
- id - .
- name - .
- department - Отдел по умолчанию.
- price - Цена.
- project - Проект.
- enabled - Включено.
Function: partner.categories.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 "partner" function).
- elid - unique identifier ("id" element of "partner.categories" 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 "partner" 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 "partner" function).
- elid - unique identifier ("id" element of "partner.categories" function)
- additional query parameters ...
- Result: successfull 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".)
Function: partner.categories.delete
Parameters:
- plid - parent list unique identifier ("id" element of "partner" function).
- elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "id" element of "partner.categories" function.
Result: successful operation or error message
Function: partner.categories.enable
Parameters:
- plid - parent list unique identifier ("id" element of "partner" function).
- elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "id" element of "partner.categories" function.
Result: successful operation or error message
Function: partner.categories.disable
Parameters:
- plid - parent list unique identifier ("id" element of "partner" function).
- elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "id" element of "partner.categories" function.
Result: successful operation or error message
Function: partner.itemtype
Parameters:
- elid - unique identifier ("id" element of "partner" function).
Result: elements list
- id - .
- name - Тип.
- active - Разрешено.
Function: partner.itemtype.enable
Parameters:
- plid - parent list unique identifier ("id" element of "partner" function).
- elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "id" element of "partner.itemtype" function.
Result: successful operation or error message
Function: partner.itemtype.disable
Parameters:
- plid - parent list unique identifier ("id" element of "partner" function).
- elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "id" element of "partner.itemtype" function.
Result: successful operation or error message
Function: partner.su
Customer
Customers
Function: account
Result: the list of elements
- id - .
- name - Name.
Function: register
The function is simultaneously used to view and change form's data
View data:
- Result: parameters list
Change the data:
- Parameters:
- sok - the parameter must not be empty, generally "yes".
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
- lang - Interface language.
- project - .
- project - Username.
- partner - Username.
- sesid - Username.
- tologon - Username.
- welcomfunc - Username.
- welcomparam - Username.
- username - Username.
- partnercookie - Username.
- cntid - Username.
- passwd - Access password.
- confirm - Confirm password.
- email - E-mail.
- country - Country.
- ptype - Account type. If the pcompany value is selected the parameters are allowed to use: 'cname'
- name - Company name.
- person - Contact person.
- knowus - How did you learn about us.
Function: account.edit
The function is simultaneously used to view and change object's parameters.
View object's parameters:
- Parameters:
- elid - unique identifier ("id" element of "account" function)
- Result: parameters list
Change an object:
- Parameters:
- sok - the parameter must not be empty, generally "yes".
- elid - unique identifier ("id" element of "account" function)
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
- name - Name.
- regdate - Registration date.
- regip - Registration IP.
- validphone - Verified phone number. The parameter may vary depending on feature fraud.
- note - Note.
- attitude - Your attitude to the client .
Function: account.delete
Parameters:
- elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "id" element of "account" function.
Result: successful operation or error message
Function: account.group
Parameters:
- elid - unique identifier ("id" element of "account" function).
Result: elements list
- id - .
- name - Group.
- active - This customer is assigned to the selected customer group .
Function: account.group.enable
Parameters:
- plid - parent list unique identifier ("id" element of "account" function).
- elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "id" element of "account.group" function.
Result: successful operation or error message
Function: account.group.disable
Parameters:
- plid - parent list unique identifier ("id" element of "account" function).
- elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "id" element of "account.group" function.
Result: successful operation or error message
Function: account.project
Parameters:
- elid - unique identifier ("id" element of "account" function).
Result: elements list
- id - .
- name - Project.
- active - The selected project is active.
Function: account.project.enable
Parameters:
- plid - parent list unique identifier ("id" element of "account" function).
- elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "id" element of "account.project" function.
Result: successful operation or error message
Function: account.project.disable
Parameters:
- plid - parent list unique identifier ("id" element of "account" function).
- elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "id" element of "account.project" function.
Result: successful operation or error message
Function: account.discount
Parameters:
- elid - unique identifier ("id" element of "account" function).
Result: elements list
- id - .
- name - .
- value - Value.
- period - Validity period.
- cname - Condition.
Function: account.discount.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 "account" function).
- elid - unique identifier ("id" element of "account.discount" 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 "account" 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 "account" function).
- elid - unique identifier ("id" element of "account.discount" function)
- additional query parameters ...
- Result: successfull operation or error message
The list object's parameters or additional query parameters (see above):
Function: account.discount.delete
Parameters:
- plid - parent list unique identifier ("id" element of "account" function).
- elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "id" element of "account.discount" function.
Result: successful operation or error message
Function: account.currency
Parameters:
- elid - unique identifier ("id" element of "account" function).
Result: elements list
- pair - The list element unique identifier
- base - Currency.
- relate - Currency.
- rate - Personal currency rate.
Function: account.currency.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 "account" function).
- elid - unique identifier ("pair" element of "account.currency" 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 "account" 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 "account" function).
- elid - unique identifier ("pair" element of "account.currency" function)
- additional query parameters ...
- Result: successfull operation or error message
The list object's parameters or additional query parameters (see above):
- base - Currency.
- relate - To currency.
- rate - Currency rate.
Function: account.currency.delete
Parameters:
- plid - parent list unique identifier ("id" element of "account" function).
- elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "pair" element of "account.currency" function.
Result: successful operation or error message
Function: account.item
Parameters:
- elid - unique identifier ("id" element of "account" function).
Result: elements list
- id - .
- name - .
- status - Status.
Function: credit
Parameters:
- elid - unique identifier ("id" element of "account" function).
Result: elements list
- id - .
- num - Invoice number.
- cdate - Date.
- sender - Payer.
- recipient - Payee.
- ctype - Payment method.
- amount - Total.
- nativeamount - Amount in native currency .
- state - Status.
Function: credit.delete
Parameters:
- plid - parent list unique identifier ("id" element of "account" function).
- elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "id" element of "credit" function.
Result: successful operation or error message
Function: invoice
Parameters:
- elid - unique identifier ("id" element of "account" function).
Result: elements list
- id - .
- num - Number.
- cdate - Date.
- provider - Provider.
- customer - Customer.
- amount - Amount.
Function: expense
Parameters:
- elid - unique identifier ("id" element of "account" function).
Result: elements list
- id - .
- cdate - Date.
- name - Description.
- quantity - Number .
- amount - Total.
- credits - Payment documents .
- notpayd - Not paid .
Function: accountinfo
Parameters:
- elid - unique identifier ("id" element of "account" function).
Result: elements list
- id - .
- name - .
- project - Project.
- balance - Balance of account .
- currency - Currency.
- enoughdays - You will run out of money in .
Function: item
Result: the list of elements
- id - .
- name - .
- pricelist - Тарифный план.
- expiredate - Действует до.
- cost - Стоимость.
- status - Состояние.
Function: item.period
The function is simultaneously used to view and change object's parameters.
View object's parameters:
- Parameters:
- elid - unique identifier ("id" element of "item" function)
- Result: parameters list
Change an object:
- Parameters:
- sok - the parameter must not be empty, generally "yes".
- elid - unique identifier ("id" element of "item" function)
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
- pricename - Package .
- name - Name .
- ip - IP-address .
- expiredate - Valid until .
- period - Period .
- cost - Cost .
- payfrom - Pay by. If the neworder value is selected the parameters are allowed to use: 'paynow'
- paynow - Pay now . (Optional parameter. To enable the option click "on".)
Function: account.setfilter
Function: editnews
- parentfunc - .
- category - Категория.
- isdefaultresponder - Перемещать тикет на меня, при ответах. (Optional parameter. To enable the option click "on".)
- onlysetlang - Строгое соответсвие языка. (Optional parameter. To enable the option click "on".)
- subject_en - Тема.
- text_en - Текст.
Function: account.su
Payer profiles
Function: profile
Result: the list of elements
- id - .
- name - .
Function: profile.edit
The function is simultaneously used to view and change object's parameters.
View object's parameters:
- Parameters:
- elid - unique identifier ("id" element of "profile" function)
- Result: parameters list
Change an object:
- Parameters:
- sok - the parameter must not be empty, generally "yes".
- elid - unique identifier ("id" element of "profile" function)
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
Function: profile.delete
Parameters:
- elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "id" element of "profile" function.
Result: successful operation or error message
Function: profile.reconciliation
The function is simultaneously used to view and change object's parameters.
View object's parameters:
- Parameters:
- elid - unique identifier ("id" element of "profile" function)
- Result: parameters list
Change an object:
- Parameters:
- sok - the parameter must not be empty, generally "yes".
- elid - unique identifier ("id" element of "profile" function)
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
- company - Company.
- customer - Company.
- currency - Currency .
- fromdate - Start date .
- todate - End date .
- savetopdf - Save as PDF . (Optional parameter. To enable the option click "on".) The parameter may vary depending on feature svrpdfutil.
Contracts
Function: contract
Result: the list of elements
- id - .
- num - Number.
- cdate - Date.
- client - Client.
- company - Company.
- contrtype - Contract type.
- state - Status.
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.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.rcategories
Parameters:
- elid - unique identifier ("id" element of "user" function).
Result: elements list
- name - Department name .
- department - Your department .
- enabled - .
Function: user.rcategories.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.rcategories" 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.rcategories" function)
- additional query parameters ...
- Result: successfull operation or error message
The list object's parameters or additional query parameters (see above):
- name - Name .
- department - Your department .
- remoteid - Remote department ID .
Function: user.rcategories.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.rcategories" function.
Result: successful operation or error message
Function: user.rcategories.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 "id" element of "user.rcategories" function.
Result: successful operation or error message
Function: user.rcategories.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 "id" element of "user.rcategories" function.
Result: successful operation or error message
Function: user.setfilter
Customer groups
Function: accgroup
Result: the list of elements
- id - .
- name - .
Function: accgroup.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 "accgroup" 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 "accgroup" function)
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
- name - .
- autoaddition - Assign to the group automatically upon registration . (Optional parameter. To enable the option click "on".) Active parameter allows the use of the following parameters: 'priority','project','country','status','custom','conditions'
- priority - Priority .
- project - Project .
- country - Country .
- ptype - Status .
- custom - Custom conditions .
Function: accgroup.delete
Parameters:
- elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "id" element of "accgroup" function.
Result: successful operation or error message
Function: accgroup.member
Parameters:
- elid - unique identifier ("id" element of "accgroup" function).
Result: elements list
- id - .
- name - Account.
- active - Active.
Function: accgroup.member.enable
Parameters:
- plid - parent list unique identifier ("id" element of "accgroup" function).
- elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "id" element of "accgroup.member" function.
Result: successful operation or error message
Function: accgroup.member.disable
Parameters:
- plid - parent list unique identifier ("id" element of "accgroup" function).
- elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "id" element of "accgroup.member" function.
Result: successful operation or error message
Function: accgroup.discount
Parameters:
- elid - unique identifier ("id" element of "accgroup" function).
Result: elements list
- id - .
- name - .
- value - Value.
- period - Validity period.
- cname - Condition.
Function: accgroup.discount.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 "accgroup" function).
- elid - unique identifier ("id" element of "accgroup.discount" 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 "accgroup" 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 "accgroup" function).
- elid - unique identifier ("id" element of "accgroup.discount" function)
- additional query parameters ...
- Result: successfull operation or error message
The list object's parameters or additional query parameters (see above):
Function: accgroup.discount.delete
Parameters:
- plid - parent list unique identifier ("id" element of "accgroup" function).
- elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "id" element of "accgroup.discount" function.
Result: successful operation or error message
CRM
Function: crm
Result: the list of elements
- id - .
- name - .
- regdate - Дата регистрации.
- regby - Зарегистрирован.
- city - Город.
- clientstate - Статус.
Function: crm.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 "crm" 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 "crm" function)
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
- project - Проект.
- ptype - Статус. If the pcompany value is selected the parameters are allowed to use: 'cname'
- name - Название компании.
- person - Контактное лицо.
- email - E-mail.
- username - Имя пользователя.
- validphone - Телефон.
- city - Город.
- note - Примечание.
- createnew - Создать новую задачу. (Optional parameter. To enable the option click "on".)
Function: crm.relation
Parameters:
- elid - unique identifier ("id" element of "crm" function).
Result: elements list
- id - .
- taskdate - .
- tasktype - .
- employee - .
- info - .
- state - .
Function: crm.relation.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 "crm" function).
- elid - unique identifier ("id" element of "crm.relation" 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 "crm" 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 "crm" function).
- elid - unique identifier ("id" element of "crm.relation" function)
- additional query parameters ...
- Result: successfull operation or error message
The list object's parameters or additional query parameters (see above):
Function: crm.relation.delete
Parameters:
- plid - parent list unique identifier ("id" element of "crm" function).
- elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "id" element of "crm.relation" function.
Result: successful operation or error message
Function: account.setfilter
Function: editnews
- parentfunc - .
- category - Категория.
- isdefaultresponder - Перемещать тикет на меня, при ответах. (Optional parameter. To enable the option click "on".)
- onlysetlang - Строгое соответсвие языка. (Optional parameter. To enable the option click "on".)
- subject_en - Тема.
- text_en - Текст.
Function: account.su
Tasks
Function: crmtask
Result: the list of elements
- id - .
- taskdate - .
- tasktype - .
- employee - .
- accname - Клиент.
- city - Город.
- state - .
Function: crmtask.edit
The function is simultaneously used to view and change object's parameters.
View object's parameters:
- Parameters:
- elid - unique identifier ("id" element of "crmtask" function)
- Result: parameters list
Change an object:
- Parameters:
- sok - the parameter must not be empty, generally "yes".
- elid - unique identifier ("id" element of "crmtask" function)
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
- createnew - Создать новую задачу. (Optional parameter. To enable the option click "on".)
- newaccount - Список всех задач по клиенту.
Function: crmtask.delete
Parameters:
- elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "id" element of "crmtask" function.
Result: successful operation or error message
Function: crmtask.setfilter
Function: editnews
- parentfunc - .
- category - Категория.
- isdefaultresponder - Перемещать тикет на меня, при ответах. (Optional parameter. To enable the option click "on".)
- onlysetlang - Строгое соответсвие языка. (Optional parameter. To enable the option click "on".)
- subject_en - Тема.
- text_en - Текст.
Function: crmtask.su
Services
Software licenses
Function: software
Result: the list of elements
- id - ID.
- licname - License name.
- ip - License IP.
- price - Software.
- period - Order period.
- expiredate - Expiry date.
- status - Status.
Function: software.edit
The function is simultaneously used to view and change object's parameters.
View object's parameters:
- Parameters:
- elid - unique identifier ("id" element of "software" function)
- Result: parameters list
Change an object:
- Parameters:
- sok - the parameter must not be empty, generally "yes".
- elid - unique identifier ("id" element of "software" function)
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
- curprice - Software.
- price - Software.
- cost - Cost.
- licname - License name.
- ip - License IP-address .
- password - Administrator password.
- regkey - Registration key.
- regclear - Delete all existing registrations. (Optional parameter. To enable the option click "on".)
- note - Notes.
Function: software.period
The function is simultaneously used to view and change object's parameters.
View object's parameters:
- Parameters:
- elid - unique identifier ("id" element of "software" function)
- Result: parameters list
Change an object:
- Parameters:
- sok - the parameter must not be empty, generally "yes".
- elid - unique identifier ("id" element of "software" function)
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
- pricename - Software.
- licname - License name.
- ip - License IP.
- expiredate - Valid until .
- period - Period.
- cost - Cost.
- payfrom - Pay by . If the neworder value is selected the parameters are allowed to use: 'paynow'
- paynow - Pay for the service after placing the order . (Optional parameter. To enable the option click "on".)
Function: software.enable
Parameters:
- elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "id" element of "software" function.
Result: successful operation or error message
Function: software.disable
Parameters:
- elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "id" element of "software" function.
Result: successful operation or error message
Function: software.delete
Parameters:
- elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "id" element of "software" function.
Result: successful operation or error message
Function: item.detail
Parameters:
- elid - unique identifier ("id" element of "software" function).
Result: elements list
- id - .
- name - Parameter.
- included - Included into the package .
- addon - Add-ons.
- total - Allocated/Available. Attributes :
- used - The used number.
- limit - Max value limitation
- price - Add-on price.
Function: item.detail.edit
The function is simultaneously used to view and change object's parameters.
View objects parameters:
- Parameters:
- plid - parent list unique identifier ("id" element of "software" function).
- elid - unique identifier ("id" element of "item.detail" function)
- Result: parameters list
Change an object:
- Parameters:
- sok - the parameter must not be empty, generally "yes".
- plid - parent list unique identifier ("id" element of "software" function).
- elid - unique identifier ("id" element of "item.detail" function)
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
- amount - More.
- enumitem - Item.
- unlimit - . (Optional parameter. To enable the option click "on".)
- enabled - . (Optional parameter. To enable the option click "on".)
- step - Monthly cost.
- currency - Monthly cost.
- price - Monthly cost.
- h_specprice - Monthly cost.
- cost - Monthly cost.
- plimit - Included into the package .
- specprice - Special price.
- noruncp - . (Optional parameter. To enable the option click "on".)
- note - Note.
ISPmanager support
Function: softsupport
Result: the list of elements
- id - .
- licid - Software ID.
- licip - License IP-address .
- price - License type.
- expire - Supported untill.
- status - Status.
Function: softsupport.edit
The function is simultaneously used to view and change object's parameters.
View object's parameters:
- Parameters:
- elid - unique identifier ("id" element of "softsupport" function)
- Result: parameters list
Change an object:
- Parameters:
- sok - the parameter must not be empty, generally "yes".
- elid - unique identifier ("id" element of "softsupport" function)
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
- licid - License ID.
- lickey - Registration key.
- prolong - Renew for 1 month. (Optional parameter. To enable the option click "on".) Active parameter allows the use of the following parameters: 'cost','pay'
- cost - Cost.
- needpay - Pay by .
- payfrom - Pay by .
- note - Note.
Function: softsupport.delete
Parameters:
- elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "id" element of "softsupport" function.
Result: successful operation or error message
System administration
Function: sysadmin
Result: the list of elements
- id - .
- ip - Server IP-address.
- price - Administration type.
- period - Period.
- expire - Expiration date.
- status - Status.
Function: sysadmin.edit
The function is simultaneously used to view and change object's parameters.
View object's parameters:
- Parameters:
- elid - unique identifier ("id" element of "sysadmin" function)
- Result: parameters list
Change an object:
- Parameters:
- sok - the parameter must not be empty, generally "yes".
- elid - unique identifier ("id" element of "sysadmin" function)
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
- curprice - Administration type.
- price - Administration type.
- period - Period.
- cost - Cost.
- expire - Valid until .
- ip - IP-address.
- srvpasswd - Server root password.
- payfrom - Pay by .
- note - Notes.
Function: sysadmin.delete
Parameters:
- elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "id" element of "sysadmin" function.
Result: successful operation or error message
Domain names
Function: domain
Result: the list of elements
- id - .
- name - Имя.
- expire - Дата окончания регистрации.
- autoperiod - Автопродление.
- domainstatus - Статус домена.
- itemstatus - Состояние услуги.
- unverified - Не заверен.
- processing - Документы отправлены.
- verified - Заверен.
- withdocs - Файлы прикреплены.
Function: domain.sendfiles
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
Web Hosting
Function: vhost
Result: the list of elements
- id - .
- domain - .
- username - Username.
- price - Package.
- expiredate - Expiation date .
- status - Status.
Function: vhost.edit
The function is simultaneously used to view and change object's parameters.
View object's parameters:
- Parameters:
- elid - unique identifier ("id" element of "vhost" function)
- Result: parameters list
Change an object:
- Parameters:
- sok - the parameter must not be empty, generally "yes".
- elid - unique identifier ("id" element of "vhost" function)
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
- curprice - Package .
- price - Package .
- username - Username.
- ip - Assigned IP address.
- domain - .
- createdate - Order date .
- suspenddate - Suspension date.
- server - Applied server.
- note - Notes.
Function: item.period
The function is simultaneously used to view and change object's parameters.
View object's parameters:
- Parameters:
- elid - unique identifier ("id" element of "vhost" function)
- Result: parameters list
Change an object:
- Parameters:
- sok - the parameter must not be empty, generally "yes".
- elid - unique identifier ("id" element of "vhost" function)
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
- pricename - Package .
- name - Name .
- ip - IP-address .
- expiredate - Valid until .
- period - Period .
- cost - Cost .
- payfrom - Pay by. If the neworder value is selected the parameters are allowed to use: 'paynow'
- paynow - Pay now . (Optional parameter. To enable the option click "on".)
Function: vhost.delete
Parameters:
- elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "id" element of "vhost" function.
Result: successful operation or error message
Function: item.detail
Parameters:
- elid - unique identifier ("id" element of "vhost" function).
Result: elements list
- id - .
- name - Parameter.
- included - Included into the package .
- addon - Add-ons.
- total - Allocated/Available. Attributes :
- used - The used number.
- limit - Max value limitation
- price - Add-on price.
Function: item.detail.edit
The function is simultaneously used to view and change object's parameters.
View objects parameters:
- Parameters:
- plid - parent list unique identifier ("id" element of "vhost" function).
- elid - unique identifier ("id" element of "item.detail" function)
- Result: parameters list
Change an object:
- Parameters:
- sok - the parameter must not be empty, generally "yes".
- plid - parent list unique identifier ("id" element of "vhost" function).
- elid - unique identifier ("id" element of "item.detail" function)
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
- amount - More.
- enumitem - Item.
- unlimit - . (Optional parameter. To enable the option click "on".)
- enabled - . (Optional parameter. To enable the option click "on".)
- step - Monthly cost.
- currency - Monthly cost.
- price - Monthly cost.
- h_specprice - Monthly cost.
- cost - Monthly cost.
- plimit - Included into the package .
- specprice - Special price.
- noruncp - . (Optional parameter. To enable the option click "on".)
- note - Note.
Function: item.ip
Parameters:
- elid - unique identifier ("id" element of "vhost" function).
Result: elements list
- name - IP-addresses.
Function: item.ip.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 "vhost" function).
- elid - unique identifier ("name" element of "item.ip" 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 "vhost" 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 "vhost" function).
- elid - unique identifier ("name" element of "item.ip" function)
- additional query parameters ...
- Result: successfull operation or error message
The list object's parameters or additional query parameters (see above):
- type - Type .
- domain - .
- net - Network.
- allowmanual - Add only to the billing system . (Optional parameter. To enable the option click "on".)
- ipmanual - IP-address.
Function: item.ip.delete
- nodelcp - Delete from the billing only . (Optional parameter. To enable the option click "on".)
Function: item.welcome
The function is simultaneously used to view and change object's parameters.
View object's parameters:
- Parameters:
- elid - unique identifier ("id" element of "vhost" function)
- Result: parameters list
Change an object:
- Parameters:
- sok - the parameter must not be empty, generally "yes".
- elid - unique identifier ("id" element of "vhost" function)
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
- welcomemsg - .
Web Hosting reselling
Function: rhost
Result: the list of elements
- id - .
- username - User name.
- price - Package .
- expiredate - Expiation date .
- status - Status.
Function: rhost.edit
The function is simultaneously used to view and change object's parameters.
View object's parameters:
- Parameters:
- elid - unique identifier ("id" element of "rhost" function)
- Result: parameters list
Change an object:
- Parameters:
- sok - the parameter must not be empty, generally "yes".
- elid - unique identifier ("id" element of "rhost" function)
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
- curprice - Package .
- price - Package .
- status - Status.
- username - User name.
- createdate - Order date .
- suspenddate - Suspension date.
- server - Associated server.
- note - Note.
Function: item.period
The function is simultaneously used to view and change object's parameters.
View object's parameters:
- Parameters:
- elid - unique identifier ("id" element of "rhost" function)
- Result: parameters list
Change an object:
- Parameters:
- sok - the parameter must not be empty, generally "yes".
- elid - unique identifier ("id" element of "rhost" function)
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
- pricename - Package .
- name - Name .
- ip - IP-address .
- expiredate - Valid until .
- period - Period .
- cost - Cost .
- payfrom - Pay by. If the neworder value is selected the parameters are allowed to use: 'paynow'
- paynow - Pay now . (Optional parameter. To enable the option click "on".)
Function: rhost.delete
Parameters:
- elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "id" element of "rhost" function.
Result: successful operation or error message
Function: item.detail
Parameters:
- elid - unique identifier ("id" element of "rhost" function).
Result: elements list
- id - .
- name - Parameter.
- included - Included into the package .
- addon - Add-ons.
- total - Allocated/Available. Attributes :
- used - The used number.
- limit - Max value limitation
- price - Add-on price.
Function: item.detail.edit
The function is simultaneously used to view and change object's parameters.
View objects parameters:
- Parameters:
- plid - parent list unique identifier ("id" element of "rhost" function).
- elid - unique identifier ("id" element of "item.detail" function)
- Result: parameters list
Change an object:
- Parameters:
- sok - the parameter must not be empty, generally "yes".
- plid - parent list unique identifier ("id" element of "rhost" function).
- elid - unique identifier ("id" element of "item.detail" function)
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
- amount - More.
- enumitem - Item.
- unlimit - . (Optional parameter. To enable the option click "on".)
- enabled - . (Optional parameter. To enable the option click "on".)
- step - Monthly cost.
- currency - Monthly cost.
- price - Monthly cost.
- h_specprice - Monthly cost.
- cost - Monthly cost.
- plimit - Included into the package .
- specprice - Special price.
- noruncp - . (Optional parameter. To enable the option click "on".)
- note - Note.
Function: item.ip
Parameters:
- elid - unique identifier ("id" element of "rhost" function).
Result: elements list
- name - IP-addresses.
Function: item.ip.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 "rhost" function).
- elid - unique identifier ("name" element of "item.ip" 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 "rhost" 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 "rhost" function).
- elid - unique identifier ("name" element of "item.ip" function)
- additional query parameters ...
- Result: successfull operation or error message
The list object's parameters or additional query parameters (see above):
- type - Type .
- domain - .
- net - Network.
- allowmanual - Add only to the billing system . (Optional parameter. To enable the option click "on".)
- ipmanual - IP-address.
Function: item.ip.delete
- nodelcp - Delete from the billing only . (Optional parameter. To enable the option click "on".)
Function: item.welcome
The function is simultaneously used to view and change object's parameters.
View object's parameters:
- Parameters:
- elid - unique identifier ("id" element of "rhost" function)
- Result: parameters list
Change an object:
- Parameters:
- sok - the parameter must not be empty, generally "yes".
- elid - unique identifier ("id" element of "rhost" function)
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
- welcomemsg - .
VPS
Function: vds
Result: the list of elements
- id - .
- domain - .
- ip - IP-address.
- price - Package.
- expiredate - Valid until .
- status - Status.
Function: vds.edit
The function is simultaneously used to view and change object's parameters.
View object's parameters:
- Parameters:
- elid - unique identifier ("id" element of "vds" function)
- Result: parameters list
Change an object:
- Parameters:
- sok - the parameter must not be empty, generally "yes".
- elid - unique identifier ("id" element of "vds" function)
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
- curprice - Package.
- price - Package.
- domain - .
- ip - IP-address.
- createdate - Creation date.
- suspenddate - Suspension date.
- deletedate - Date of deletion .
- server - Applied server.
- note - Note.
Function: item.period
The function is simultaneously used to view and change object's parameters.
View object's parameters:
- Parameters:
- elid - unique identifier ("id" element of "vds" function)
- Result: parameters list
Change an object:
- Parameters:
- sok - the parameter must not be empty, generally "yes".
- elid - unique identifier ("id" element of "vds" function)
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
- pricename - Package .
- name - Name .
- ip - IP-address .
- expiredate - Valid until .
- period - Period .
- cost - Cost .
- payfrom - Pay by. If the neworder value is selected the parameters are allowed to use: 'paynow'
- paynow - Pay now . (Optional parameter. To enable the option click "on".)
Function: vds.delete
Parameters:
- elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "id" element of "vds" function.
Result: successful operation or error message
Function: item.detail
Parameters:
- elid - unique identifier ("id" element of "vds" function).
Result: elements list
- id - .
- name - Parameter.
- included - Included into the package .
- addon - Add-ons.
- total - Allocated/Available. Attributes :
- used - The used number.
- limit - Max value limitation
- price - Add-on price.
Function: item.detail.edit
The function is simultaneously used to view and change object's parameters.
View objects parameters:
- Parameters:
- plid - parent list unique identifier ("id" element of "vds" function).
- elid - unique identifier ("id" element of "item.detail" function)
- Result: parameters list
Change an object:
- Parameters:
- sok - the parameter must not be empty, generally "yes".
- plid - parent list unique identifier ("id" element of "vds" function).
- elid - unique identifier ("id" element of "item.detail" function)
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
- amount - More.
- enumitem - Item.
- unlimit - . (Optional parameter. To enable the option click "on".)
- enabled - . (Optional parameter. To enable the option click "on".)
- step - Monthly cost.
- currency - Monthly cost.
- price - Monthly cost.
- h_specprice - Monthly cost.
- cost - Monthly cost.
- plimit - Included into the package .
- specprice - Special price.
- noruncp - . (Optional parameter. To enable the option click "on".)
- note - Note.
Function: item.ip
Parameters:
- elid - unique identifier ("id" element of "vds" function).
Result: elements list
- name - IP-addresses.
Function: item.ip.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 "vds" function).
- elid - unique identifier ("name" element of "item.ip" 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 "vds" 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 "vds" function).
- elid - unique identifier ("name" element of "item.ip" function)
- additional query parameters ...
- Result: successfull operation or error message
The list object's parameters or additional query parameters (see above):
- type - Type .
- domain - .
- net - Network.
- allowmanual - Add only to the billing system . (Optional parameter. To enable the option click "on".)
- ipmanual - IP-address.
Function: item.ip.delete
- nodelcp - Delete from the billing only . (Optional parameter. To enable the option click "on".)
Function: item.welcome
The function is simultaneously used to view and change object's parameters.
View object's parameters:
- Parameters:
- elid - unique identifier ("id" element of "vds" function)
- Result: parameters list
Change an object:
- Parameters:
- sok - the parameter must not be empty, generally "yes".
- elid - unique identifier ("id" element of "vds" function)
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
- welcomemsg - .
VPS reselling
Function: rvds
Result: the list of elements
- id - .
- username - User name.
- price - Package.
- expiredate - Expiation date .
- status - Status.
Function: rvds.edit
The function is simultaneously used to view and change object's parameters.
View object's parameters:
- Parameters:
- elid - unique identifier ("id" element of "rvds" function)
- Result: parameters list
Change an object:
- Parameters:
- sok - the parameter must not be empty, generally "yes".
- elid - unique identifier ("id" element of "rvds" function)
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
- curprice - Package .
- price - Package .
- status - Status.
- username - User name.
- createdate - Order date.
- suspenddate - Suspension date.
- server - Service server.
- note - Note.
Function: item.period
The function is simultaneously used to view and change object's parameters.
View object's parameters:
- Parameters:
- elid - unique identifier ("id" element of "rvds" function)
- Result: parameters list
Change an object:
- Parameters:
- sok - the parameter must not be empty, generally "yes".
- elid - unique identifier ("id" element of "rvds" function)
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
- pricename - Package .
- name - Name .
- ip - IP-address .
- expiredate - Valid until .
- period - Period .
- cost - Cost .
- payfrom - Pay by. If the neworder value is selected the parameters are allowed to use: 'paynow'
- paynow - Pay now . (Optional parameter. To enable the option click "on".)
Function: rvds.delete
Parameters:
- elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "id" element of "rvds" function.
Result: successful operation or error message
Function: item.detail
Parameters:
- elid - unique identifier ("id" element of "rvds" function).
Result: elements list
- id - .
- name - Parameter.
- included - Included into the package .
- addon - Add-ons.
- total - Allocated/Available. Attributes :
- used - The used number.
- limit - Max value limitation
- price - Add-on price.
Function: item.detail.edit
The function is simultaneously used to view and change object's parameters.
View objects parameters:
- Parameters:
- plid - parent list unique identifier ("id" element of "rvds" function).
- elid - unique identifier ("id" element of "item.detail" function)
- Result: parameters list
Change an object:
- Parameters:
- sok - the parameter must not be empty, generally "yes".
- plid - parent list unique identifier ("id" element of "rvds" function).
- elid - unique identifier ("id" element of "item.detail" function)
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
- amount - More.
- enumitem - Item.
- unlimit - . (Optional parameter. To enable the option click "on".)
- enabled - . (Optional parameter. To enable the option click "on".)
- step - Monthly cost.
- currency - Monthly cost.
- price - Monthly cost.
- h_specprice - Monthly cost.
- cost - Monthly cost.
- plimit - Included into the package .
- specprice - Special price.
- noruncp - . (Optional parameter. To enable the option click "on".)
- note - Note.
Function: item.ip
Parameters:
- elid - unique identifier ("id" element of "rvds" function).
Result: elements list
- name - IP-addresses.
Function: item.ip.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 "rvds" function).
- elid - unique identifier ("name" element of "item.ip" 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 "rvds" 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 "rvds" function).
- elid - unique identifier ("name" element of "item.ip" function)
- additional query parameters ...
- Result: successfull operation or error message
The list object's parameters or additional query parameters (see above):
- type - Type .
- domain - .
- net - Network.
- allowmanual - Add only to the billing system . (Optional parameter. To enable the option click "on".)
- ipmanual - IP-address.
Function: item.ip.delete
- nodelcp - Delete from the billing only . (Optional parameter. To enable the option click "on".)
Function: rvds.info
The function is simultaneously used to view and change object's parameters.
View object's parameters:
- Parameters:
- elid - unique identifier ("id" element of "rvds" function)
- Result: parameters list
Change an object:
- Parameters:
- sok - the parameter must not be empty, generally "yes".
- elid - unique identifier ("id" element of "rvds" function)
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
Function: item.welcome
The function is simultaneously used to view and change object's parameters.
View object's parameters:
- Parameters:
- elid - unique identifier ("id" element of "rvds" function)
- Result: parameters list
Change an object:
- Parameters:
- sok - the parameter must not be empty, generally "yes".
- elid - unique identifier ("id" element of "rvds" function)
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
- welcomemsg - .
Dedicated servers
Function: dedic
Result: the list of elements
- id - .
- domain - .
- ip - IP-address.
- price - Package.
- expiredate - Expiration date .
- status - Status.
Function: dedic.edit
The function is simultaneously used to view and change object's parameters.
View object's parameters:
- Parameters:
- elid - unique identifier ("id" element of "dedic" function)
- Result: parameters list
Change an object:
- Parameters:
- sok - the parameter must not be empty, generally "yes".
- elid - unique identifier ("id" element of "dedic" function)
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
- curprice - Package.
- price - Package.
- dsuser - Username.
- dsuserpwd - Password.
- confirm - Confirm password.
- ip - IP-address.
- racknumber - Rack number .
- createdate - Creation date.
- suspenddate - Suspension date.
- daletedate - Deletion date .
- server - Associated server.
- status - Status.
- note - Note.
Function: item.period
The function is simultaneously used to view and change object's parameters.
View object's parameters:
- Parameters:
- elid - unique identifier ("id" element of "dedic" function)
- Result: parameters list
Change an object:
- Parameters:
- sok - the parameter must not be empty, generally "yes".
- elid - unique identifier ("id" element of "dedic" function)
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
- pricename - Package .
- name - Name .
- ip - IP-address .
- expiredate - Valid until .
- period - Period .
- cost - Cost .
- payfrom - Pay by. If the neworder value is selected the parameters are allowed to use: 'paynow'
- paynow - Pay now . (Optional parameter. To enable the option click "on".)
Function: dedic.delete
Parameters:
- elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "id" element of "dedic" function.
Result: successful operation or error message
Function: item.detail
Parameters:
- elid - unique identifier ("id" element of "dedic" function).
Result: elements list
- id - .
- name - Parameter.
- included - Included into the package .
- addon - Add-ons.
- total - Allocated/Available. Attributes :
- used - The used number.
- limit - Max value limitation
- price - Add-on price.
Function: item.detail.edit
The function is simultaneously used to view and change object's parameters.
View objects parameters:
- Parameters:
- plid - parent list unique identifier ("id" element of "dedic" function).
- elid - unique identifier ("id" element of "item.detail" function)
- Result: parameters list
Change an object:
- Parameters:
- sok - the parameter must not be empty, generally "yes".
- plid - parent list unique identifier ("id" element of "dedic" function).
- elid - unique identifier ("id" element of "item.detail" function)
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
- amount - More.
- enumitem - Item.
- unlimit - . (Optional parameter. To enable the option click "on".)
- enabled - . (Optional parameter. To enable the option click "on".)
- step - Monthly cost.
- currency - Monthly cost.
- price - Monthly cost.
- h_specprice - Monthly cost.
- cost - Monthly cost.
- plimit - Included into the package .
- specprice - Special price.
- noruncp - . (Optional parameter. To enable the option click "on".)
- note - Note.
Function: item.ip
Parameters:
- elid - unique identifier ("id" element of "dedic" function).
Result: elements list
- name - IP-addresses.
Function: item.ip.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 "dedic" function).
- elid - unique identifier ("name" element of "item.ip" 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 "dedic" 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 "dedic" function).
- elid - unique identifier ("name" element of "item.ip" function)
- additional query parameters ...
- Result: successfull operation or error message
The list object's parameters or additional query parameters (see above):
- type - Type .
- domain - .
- net - Network.
- allowmanual - Add only to the billing system . (Optional parameter. To enable the option click "on".)
- ipmanual - IP-address.
Function: item.ip.delete
- nodelcp - Delete from the billing only . (Optional parameter. To enable the option click "on".)
Function: item.welcome
The function is simultaneously used to view and change object's parameters.
View object's parameters:
- Parameters:
- elid - unique identifier ("id" element of "dedic" function)
- Result: parameters list
Change an object:
- Parameters:
- sok - the parameter must not be empty, generally "yes".
- elid - unique identifier ("id" element of "dedic" function)
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
- welcomemsg - .
Servers colocation
Function: colo
Result: the list of elements
- id - .
- name - .
- price - Package .
- expiredate - Expiation date .
- status - Status .
Function: colo.edit
The function is simultaneously used to view and change object's parameters.
View object's parameters:
- Parameters:
- elid - unique identifier ("id" element of "colo" function)
- Result: parameters list
Change an object:
- Parameters:
- sok - the parameter must not be empty, generally "yes".
- elid - unique identifier ("id" element of "colo" function)
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
- curprice - Package .
- price - Package .
- racknumber - Rack number .
- dsmgrid - Server ID in DSmanager.
- createdate - Order date .
- suspenddate - Suspension date .
- server - Associated server .
- note - Notes.
Function: item.period
The function is simultaneously used to view and change object's parameters.
View object's parameters:
- Parameters:
- elid - unique identifier ("id" element of "colo" function)
- Result: parameters list
Change an object:
- Parameters:
- sok - the parameter must not be empty, generally "yes".
- elid - unique identifier ("id" element of "colo" function)
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
- pricename - Package .
- name - Name .
- ip - IP-address .
- expiredate - Valid until .
- period - Period .
- cost - Cost .
- payfrom - Pay by. If the neworder value is selected the parameters are allowed to use: 'paynow'
- paynow - Pay now . (Optional parameter. To enable the option click "on".)
Function: colo.delete
Parameters:
- elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "id" element of "colo" function.
Result: successful operation or error message
Function: item.detail
Parameters:
- elid - unique identifier ("id" element of "colo" function).
Result: elements list
- id - .
- name - Parameter.
- included - Included into the package .
- addon - Add-ons.
- total - Allocated/Available. Attributes :
- used - The used number.
- limit - Max value limitation
- price - Add-on price.
Function: item.detail.edit
The function is simultaneously used to view and change object's parameters.
View objects parameters:
- Parameters:
- plid - parent list unique identifier ("id" element of "colo" function).
- elid - unique identifier ("id" element of "item.detail" function)
- Result: parameters list
Change an object:
- Parameters:
- sok - the parameter must not be empty, generally "yes".
- plid - parent list unique identifier ("id" element of "colo" function).
- elid - unique identifier ("id" element of "item.detail" function)
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
- amount - More.
- enumitem - Item.
- unlimit - . (Optional parameter. To enable the option click "on".)
- enabled - . (Optional parameter. To enable the option click "on".)
- step - Monthly cost.
- currency - Monthly cost.
- price - Monthly cost.
- h_specprice - Monthly cost.
- cost - Monthly cost.
- plimit - Included into the package .
- specprice - Special price.
- noruncp - . (Optional parameter. To enable the option click "on".)
- note - Note.
Function: item.ip
Parameters:
- elid - unique identifier ("id" element of "colo" function).
Result: elements list
- name - IP-addresses.
Function: item.ip.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 "colo" function).
- elid - unique identifier ("name" element of "item.ip" 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 "colo" 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 "colo" function).
- elid - unique identifier ("name" element of "item.ip" function)
- additional query parameters ...
- Result: successfull operation or error message
The list object's parameters or additional query parameters (see above):
- type - Type .
- domain - .
- net - Network.
- allowmanual - Add only to the billing system . (Optional parameter. To enable the option click "on".)
- ipmanual - IP-address.
Function: item.ip.delete
- nodelcp - Delete from the billing only . (Optional parameter. To enable the option click "on".)
Function: colo.port
Parameters:
- elid - unique identifier ("id" element of "colo" function).
Result: elements list
- id - .
- name - .
- extport - Port from another colocation .
Function: colo.port.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 "colo" function).
- elid - unique identifier ("id" element of "colo.port" 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 "colo" 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 "colo" function).
- elid - unique identifier ("id" element of "colo.port" function)
- additional query parameters ...
- Result: successfull operation or error message
The list object's parameters or additional query parameters (see above):
- extport - The port from another colocation .
- vlan - Internal name .
- note - Notes.
Function: colo.port.delete
Parameters:
- plid - parent list unique identifier ("id" element of "colo" function).
- elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "id" element of "colo.port" function.
Result: successful operation or error message
Function: colo.hardware
Parameters:
- elid - unique identifier ("id" element of "colo" function).
Result: elements list
- id - .
- hardware - Description .
- receivingdate - Acceptance date .
- returndate - Date returned .
Function: item.welcome
The function is simultaneously used to view and change object's parameters.
View object's parameters:
- Parameters:
- elid - unique identifier ("id" element of "colo" function)
- Result: parameters list
Change an object:
- Parameters:
- sok - the parameter must not be empty, generally "yes".
- elid - unique identifier ("id" element of "colo" function)
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
- welcomemsg - .
DNS hosting
Function: dns
Result: the list of elements
- id - .
- username - User name.
- price - Package .
- status - Status.
Function: dns.edit
The function is simultaneously used to view and change object's parameters.
View object's parameters:
- Parameters:
- elid - unique identifier ("id" element of "dns" function)
- Result: parameters list
Change an object:
- Parameters:
- sok - the parameter must not be empty, generally "yes".
- elid - unique identifier ("id" element of "dns" function)
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
- curprice - Package .
- price - Package .
- username - User name.
- createdate - Order date .
- suspenddate - Suspension date.
- domain - .
- server - Associated server.
- note - Note.
Function: item.period
The function is simultaneously used to view and change object's parameters.
View object's parameters:
- Parameters:
- elid - unique identifier ("id" element of "dns" function)
- Result: parameters list
Change an object:
- Parameters:
- sok - the parameter must not be empty, generally "yes".
- elid - unique identifier ("id" element of "dns" function)
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
- pricename - Package .
- name - Name .
- ip - IP-address .
- expiredate - Valid until .
- period - Period .
- cost - Cost .
- payfrom - Pay by. If the neworder value is selected the parameters are allowed to use: 'paynow'
- paynow - Pay now . (Optional parameter. To enable the option click "on".)
Function: dns.delete
Parameters:
- elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "id" element of "dns" function.
Result: successful operation or error message
Function: item.detail
Parameters:
- elid - unique identifier ("id" element of "dns" function).
Result: elements list
- id - .
- name - Parameter.
- included - Included into the package .
- addon - Add-ons.
- total - Allocated/Available. Attributes :
- used - The used number.
- limit - Max value limitation
- price - Add-on price.
Function: item.detail.edit
The function is simultaneously used to view and change object's parameters.
View objects parameters:
- Parameters:
- plid - parent list unique identifier ("id" element of "dns" function).
- elid - unique identifier ("id" element of "item.detail" function)
- Result: parameters list
Change an object:
- Parameters:
- sok - the parameter must not be empty, generally "yes".
- plid - parent list unique identifier ("id" element of "dns" function).
- elid - unique identifier ("id" element of "item.detail" function)
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
- amount - More.
- enumitem - Item.
- unlimit - . (Optional parameter. To enable the option click "on".)
- enabled - . (Optional parameter. To enable the option click "on".)
- step - Monthly cost.
- currency - Monthly cost.
- price - Monthly cost.
- h_specprice - Monthly cost.
- cost - Monthly cost.
- plimit - Included into the package .
- specprice - Special price.
- noruncp - . (Optional parameter. To enable the option click "on".)
- note - Note.
Function: item.welcome
The function is simultaneously used to view and change object's parameters.
View object's parameters:
- Parameters:
- elid - unique identifier ("id" element of "dns" function)
- Result: parameters list
Change an object:
- Parameters:
- sok - the parameter must not be empty, generally "yes".
- elid - unique identifier ("id" element of "dns" function)
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
- welcomemsg - .
SSL certificates
Function: certificate
Result: the list of elements
- id - .
- domain - .
- price - Package .
- expire - Valid until .
- status - Status .
Function: certificate.edit
The function is simultaneously used to view and change object's parameters.
View object's parameters:
- Parameters:
- elid - unique identifier ("id" element of "certificate" function)
- Result: parameters list
Change an object:
- Parameters:
- sok - the parameter must not be empty, generally "yes".
- elid - unique identifier ("id" element of "certificate" function)
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
- price - Package .
- createdate - Order date .
- vemail - Confirmation e-mail .
- note - Notes.
- csr - .
- delkey - Delete the secret key from the system . (Optional parameter. To enable the option click "on".)
- privatekey - .
- crt - .
- CN - Common name .
- O - Organization .
- OU - Organization unit .
- C - Country code (2 letter).
- ST - State/province name.
- L - City.
- emailAddress - Email.
- adm_fname - First name.
- adm_lname - Last name.
- adm_jtitle - Job title .
- adm_email - Email.
- adm_phone - Phone number .
- tech_fname - First name.
- tech_lname - Last name.
- tech_jtitle - Job title .
- tech_email - Email.
- tech_phone - Phone number .
- org_name - Name .
- org_country - Country .
- org_state - State/province.
- org_city - City .
- org_postcode - ZIP code .
- org_address - Address .
- org_phone - Phone number .
Function: certificate.renew
The function is simultaneously used to view and change object's parameters.
View object's parameters:
- Parameters:
- elid - unique identifier ("id" element of "certificate" function)
- Result: parameters list
Change an object:
- Parameters:
- sok - the parameter must not be empty, generally "yes".
- elid - unique identifier ("id" element of "certificate" function)
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
- period - Validity period .
- cost - Cost.
- payfrom - Pay by. If the neworder value is selected the parameters are allowed to use: 'paynow'
- paynow - Pay now. (Optional parameter. To enable the option click "on".)
Function: certificate.delete
Parameters:
- elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "id" element of "certificate" function.
Result: successful operation or error message
Other services
Function: uniservice
Result: the list of elements
- id - .
- name - .
- price - Package.
- period - Period .
- expiredate - Expiation date .
- status - Status.
Function: uniservice.edit
The function is simultaneously used to view and change object's parameters.
View object's parameters:
- Parameters:
- elid - unique identifier ("id" element of "uniservice" function)
- Result: parameters list
Change an object:
- Parameters:
- sok - the parameter must not be empty, generally "yes".
- elid - unique identifier ("id" element of "uniservice" function)
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
- curprice - Package .
- price - Package .
- server - Associated server.
- note - .
Function: item.period
The function is simultaneously used to view and change object's parameters.
View object's parameters:
- Parameters:
- elid - unique identifier ("id" element of "uniservice" function)
- Result: parameters list
Change an object:
- Parameters:
- sok - the parameter must not be empty, generally "yes".
- elid - unique identifier ("id" element of "uniservice" function)
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
- pricename - Package .
- name - Name .
- ip - IP-address .
- expiredate - Valid until .
- period - Period .
- cost - Cost .
- payfrom - Pay by. If the neworder value is selected the parameters are allowed to use: 'paynow'
- paynow - Pay now . (Optional parameter. To enable the option click "on".)
Function: uniservice.delete
Parameters:
- elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "id" element of "uniservice" function.
Result: successful operation or error message
Function: item.detail
Parameters:
- elid - unique identifier ("id" element of "uniservice" function).
Result: elements list
- id - .
- name - Parameter.
- included - Included into the package .
- addon - Add-ons.
- total - Allocated/Available. Attributes :
- used - The used number.
- limit - Max value limitation
- price - Add-on price.
Function: item.detail.edit
The function is simultaneously used to view and change object's parameters.
View objects parameters:
- Parameters:
- plid - parent list unique identifier ("id" element of "uniservice" function).
- elid - unique identifier ("id" element of "item.detail" function)
- Result: parameters list
Change an object:
- Parameters:
- sok - the parameter must not be empty, generally "yes".
- plid - parent list unique identifier ("id" element of "uniservice" function).
- elid - unique identifier ("id" element of "item.detail" function)
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
- amount - More.
- enumitem - Item.
- unlimit - . (Optional parameter. To enable the option click "on".)
- enabled - . (Optional parameter. To enable the option click "on".)
- step - Monthly cost.
- currency - Monthly cost.
- price - Monthly cost.
- h_specprice - Monthly cost.
- cost - Monthly cost.
- plimit - Included into the package .
- specprice - Special price.
- noruncp - . (Optional parameter. To enable the option click "on".)
- note - Note.
Function: item.welcome
The function is simultaneously used to view and change object's parameters.
View object's parameters:
- Parameters:
- elid - unique identifier ("id" element of "uniservice" function)
- Result: parameters list
Change an object:
- Parameters:
- sok - the parameter must not be empty, generally "yes".
- elid - unique identifier ("id" element of "uniservice" function)
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
- welcomemsg - .
Hosting
Function: nichost
Result: the list of elements
- id - .
- domain - .
- nicid - Identifier .
- price - Package .
- expiredate - Valid until .
- status - Status .
Function: nichost.edit
The function is simultaneously used to view and change object's parameters.
View object's parameters:
- Parameters:
- elid - unique identifier ("id" element of "nichost" function)
- Result: parameters list
Change an object:
- Parameters:
- sok - the parameter must not be empty, generally "yes".
- elid - unique identifier ("id" element of "nichost" function)
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
- curprice - Package .
- price - Package .
- nicid - Service identifier .
- domain - .
- createdate - Order date .
- suspenddate - Suspension dare .
- note - Notes .
Function: nichost.prolong
The function is simultaneously used to view and change object's parameters.
View object's parameters:
- Parameters:
- elid - unique identifier ("id" element of "nichost" function)
- Result: parameters list
Change an object:
- Parameters:
- sok - the parameter must not be empty, generally "yes".
- elid - unique identifier ("id" element of "nichost" function)
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
- name - Name .
- expiredate - Validity period .
- period - Period .
- cost - Cost .
- payfrom - Pay by . If the neworder value is selected the parameters are allowed to use: 'paynow'
- paynow - Pay now . (Optional parameter. To enable the option click "on".)
Function: nichost.delete
Parameters:
- elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "id" element of "nichost" function.
Result: successful operation or error message
Function: item.welcome
The function is simultaneously used to view and change object's parameters.
View object's parameters:
- Parameters:
- elid - unique identifier ("id" element of "nichost" function)
- Result: parameters list
Change an object:
- Parameters:
- sok - the parameter must not be empty, generally "yes".
- elid - unique identifier ("id" element of "nichost" function)
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
- welcomemsg - .
Finances
Credits/Payments
Function: credit
Result: the list of elements
- id - .
- num - Invoice number.
- cdate - Date.
- sender - Payer.
- recipient - Payee.
- ctype - Payment method.
- amount - Total.
- nativeamount - Amount in native currency .
- state - Status.
Function: credit.delete
Parameters:
- elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "id" element of "credit" function.
Result: successful operation or error message
Invoices
Function: invoice
Result: the list of elements
- id - .
- num - Number.
- cdate - Date.
- provider - Provider.
- customer - Customer.
- amount - Amount.
Orders
Function: order
Result: the list of elements
- id - .
- name - Description.
- cdate - Date.
- total - Total.
- status - Status.
Function: order.edit
The function is simultaneously used to view and change object's parameters.
View object's parameters:
- Parameters:
- elid - unique identifier ("id" element of "order" function)
- Result: parameters list
Change an object:
- Parameters:
- sok - the parameter must not be empty, generally "yes".
- elid - unique identifier ("id" element of "order" function)
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
- name - Description.
Function: order.delete
Parameters:
- elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "id" element of "order" function.
Result: successful operation or error message
Function: order.detail
Parameters:
- elid - unique identifier ("id" element of "order" function).
Result: elements list
- id - .
- name - Description.
- amount - Total.
Function: order.detail.delete
Parameters:
- plid - parent list unique identifier ("id" element of "order" function).
- elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "id" element of "order.detail" function.
Result: successful operation or error message
Expenses
Function: expense
Result: the list of elements
- id - .
- cdate - Date.
- name - Description.
- quantity - Number .
- amount - Total.
- credits - Payment documents .
- notpayd - Not paid .
Marketing
Affiliate programs
Function: affiliate
Result: the list of elements
- id - .
- name - Название программы.
- btype - Тип бонуса.
- projectname - Проект.
Function: affiliate.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 "affiliate" 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 "affiliate" function)
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
- project - .
- name - Название программы.
- btype - Тип начислений. If the bonus value is selected the parameters are denied: 'count'
- integration - Способ интеграции.
- url - URL.
- billurl - URL биллинга.
- companycrtype - Метод оплаты.
- persent - Проценты.
- count - Количество.
- pgroup - Группа.
Function: affiliate.delete
Parameters:
- elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "id" element of "affiliate" function.
Result: successful operation or error message
Function: affiliate.discount
Parameters:
- elid - unique identifier ("id" element of "affiliate" function).
Result: elements list
- id - .
- name - .
- value - Величина.
- period - Период действия.
- cname - Условие.
Function: affiliate.discount.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 "affiliate" function).
- elid - unique identifier ("id" element of "affiliate.discount" 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 "affiliate" 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 "affiliate" function).
- elid - unique identifier ("id" element of "affiliate.discount" function)
- additional query parameters ...
- Result: successfull operation or error message
The list object's parameters or additional query parameters (see above):
Function: affiliate.discount.delete
Parameters:
- plid - parent list unique identifier ("id" element of "affiliate" function).
- elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "id" element of "affiliate.discount" function.
Result: successful operation or error message
Function: affiliate.specialrule
Parameters:
- elid - unique identifier ("id" element of "affiliate" function).
Result: elements list
- id - .
- name - Тип продукта.
- amount - Проценты.
Function: affiliate.specialrule.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 "affiliate" function).
- elid - unique identifier ("id" element of "affiliate.specialrule" 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 "affiliate" 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 "affiliate" function).
- elid - unique identifier ("id" element of "affiliate.specialrule" function)
- additional query parameters ...
- Result: successfull operation or error message
The list object's parameters or additional query parameters (see above):
- itemtype - Тип продукта.
- amount - Проценты.
Function: affiliate.specialrule.delete
Parameters:
- plid - parent list unique identifier ("id" element of "affiliate" function).
- elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "id" element of "affiliate.specialrule" function.
Result: successful operation or error message
Function: affiliate.advertisement
Parameters:
- elid - unique identifier ("id" element of "affiliate" function).
Result: elements list
- id - The list element unique identifier
- image - Изображение.
Function: affiliate.advertisement.edit
- filename - .
Function: affiliate.advertisement.delete
Parameters:
- plid - parent list unique identifier ("id" element of "affiliate" function).
- elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "id" element of "affiliate.advertisement" function.
Result: successful operation or error message
Promotions
Function: promotion
Result: the list of elements
- id - .
- name - .
- active - .
- norefund - .
- period - Period.
Function: promotion.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 "promotion" 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 "promotion" function)
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
- name - .
- project - .
- fromdate - Valid after.
- todate - Valid until.
- actiontype - Promotion type. If the 1 value is selected the parameters are allowed to use: 'at1','at2'
- payamount - Payment amount.
- disablerefund - Disable refunding . (Optional parameter. To enable the option click "on".)
- bonustype - Bonus type. If the 1 value is selected the parameters are allowed to use: 'bt1','bt2','bt3'
- bonusproduct - Product/Service.
- bonusperiod - Order period.
- bonusamount - Amount.
- info - .
Function: promotion.delete
Parameters:
- elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "id" element of "promotion" function.
Result: successful operation or error message
Promotion codes
Function: promocode
Result: the list of elements
- id - .
- name - Промокод.
- usage - Использование. Attributes :
- used - The used number.
- limit - Max value limitation
- period - Период действия.
Function: promocode.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 "promocode" 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 "promocode" function)
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
- name - Промокод.
- uselimit - Лимит использования.
- fromdate - Действует с даты.
- todate - Действует до даты.
- note - Примечание.
Function: promocode.delete
Parameters:
- elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "id" element of "promocode" function.
Result: successful operation or error message
Function: promocode.code
Parameters:
- elid - unique identifier ("id" element of "promocode" function).
Result: elements list
- name - Промокод.
- usage - Использование. Attributes :
- used - The used number.
- limit - Max value limitation
Function: promocode.code.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 "promocode" function).
- elid - unique identifier ("id" element of "promocode.code" 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 "promocode" 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 "promocode" function).
- elid - unique identifier ("id" element of "promocode.code" function)
- additional query parameters ...
- Result: successfull operation or error message
The list object's parameters or additional query parameters (see above):
- name - Промокод.
- gencount - Количество кодов.
- onlydigit - Только цифры. (Optional parameter. To enable the option click "on".)
Function: promocode.code.delete
Parameters:
- plid - parent list unique identifier ("id" element of "promocode" function).
- elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "id" element of "promocode.code" function.
Result: successful operation or error message
Function: promocode.discount
Parameters:
- elid - unique identifier ("id" element of "promocode" function).
Result: elements list
- id - .
- name - .
- value - Величина.
- period - Срок действия.
- cname - Условие.
Function: promocode.discount.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 "promocode" function).
- elid - unique identifier ("id" element of "promocode.discount" 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 "promocode" 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 "promocode" function).
- elid - unique identifier ("id" element of "promocode.discount" function)
- additional query parameters ...
- Result: successfull operation or error message
The list object's parameters or additional query parameters (see above):
Function: promocode.discount.delete
Parameters:
- plid - parent list unique identifier ("id" element of "promocode" function).
- elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "id" element of "promocode.discount" function.
Result: successful operation or error message
Function: promocode.item
Parameters:
- elid - unique identifier ("id" element of "promocode" function).
Result: elements list
- id - .
- name - .
- account - Клиент.
- status - Состояние.
- expenses - Расходы.
Promotions
Function: promoplace
Result: the list of elements
- id - .
- name - .
- project - .
- budget - Бюджет.
- click - Переходы.
- reg - Регистрации.
- customer - Покупатели.
- income - Сумма платежей.
Function: promoplace.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 "promoplace" 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 "promoplace" function)
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
- name - .
- project - .
- budget - Бюджет.
Function: promoplace.delete
Parameters:
- elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "id" element of "promoplace" function.
Result: successful operation or error message
Function: promoplace.condition
Parameters:
- elid - unique identifier ("id" element of "promoplace" function).
Result: elements list
- id - .
- value - Условие.
Function: promoplace.condition.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 "promoplace" function).
- elid - unique identifier ("id" element of "promoplace.condition" 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 "promoplace" 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 "promoplace" function).
- elid - unique identifier ("id" element of "promoplace.condition" function)
- additional query parameters ...
- Result: successfull operation or error message
The list object's parameters or additional query parameters (see above):
- ctype - Тип. If the 3 value is selected the parameters are allowed to use: 'sval' and the parameters are denied: 'val'
- comparison - Сравнение.
- value - Значение.
- svalue - Значение.
Function: promoplace.condition.delete
Parameters:
- plid - parent list unique identifier ("id" element of "promoplace" function).
- elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "id" element of "promoplace.condition" function.
Result: successful operation or error message
Function: promoplace.restat
Query settings
Function: callmgr
Result: the list of elements
- id - .
- name - Name.
- project - .
- active - Enabled .
Function: callmgr.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 "callmgr" 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 "callmgr" function)
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
- name - Name .
- project - .
- hidedays - will be hidden .
- query - Sql query .
Function: callmgr.delete
Parameters:
- elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "id" element of "callmgr" function.
Result: successful operation or error message
Function: callmgr.enable
Parameters:
- elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "id" element of "callmgr" function.
Result: successful operation or error message
Function: callmgr.disable
Parameters:
- elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "id" element of "callmgr" function.
Result: successful operation or error message
Function: callmgr.question
Parameters:
- elid - unique identifier ("id" element of "callmgr" function).
Result: elements list
- id - .
- question - Question.
Function: callmgr.question.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 "callmgr" function).
- elid - unique identifier ("id" element of "callmgr.question" 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 "callmgr" 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 "callmgr" function).
- elid - unique identifier ("id" element of "callmgr.question" function)
- additional query parameters ...
- Result: successfull operation or error message
The list object's parameters or additional query parameters (see above):
- question - Question .
Function: callmgr.question.delete
Parameters:
- plid - parent list unique identifier ("id" element of "callmgr" function).
- elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "id" element of "callmgr.question" function.
Result: successful operation or error message
Function: callmgr.question.answer
Parameters:
- elid - unique identifier ("id" element of "callmgr.question" function).
Result: elements list
- id - .
- answer - Answer .
Function: callmgr.question.answer.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 "callmgr.question" function).
- elid - unique identifier ("id" element of "callmgr.question.answer" 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 "callmgr.question" 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 "callmgr.question" function).
- elid - unique identifier ("id" element of "callmgr.question.answer" function)
- additional query parameters ...
- Result: successfull operation or error message
The list object's parameters or additional query parameters (see above):
- answer - Answer .
Function: callmgr.question.answer.delete
Parameters:
- plid - parent list unique identifier ("id" element of "callmgr.question" function).
- elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "id" element of "callmgr.question.answer" function.
Result: successful operation or error message
Function: callmgr.question.answer.respondent
Parameters:
- elid - unique identifier ("id" element of "callmgr.question.answer" function).
Result: elements list
- id - ID.
- name - Name .
Function: callmgr.question.answer.respondent.setfilter
Surveys
Function: survey
Result: the list of elements
- id - .
- name - .
- active - .
Function: survey.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 "survey" 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 "survey" function)
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
- name - .
- method - Способ опроса. If the 3 value is selected the parameters are allowed to use: 'project','hidedays'
- priority - Приоритет.
- active - Опрос активен. (Optional parameter. To enable the option click "on".)
- intro - Вступительный текст.
- final - Заключительный текст.
- project - Информация о проекте.
- hidedays - Скрыть опрос на.
- dropdays - Удалить опрос через.
Function: survey.delete
Parameters:
- elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "id" element of "survey" function.
Result: successful operation or error message
Function: survey.clone
The function is simultaneously used to view and change object's parameters.
View object's parameters:
- Parameters:
- elid - unique identifier ("id" element of "survey" function)
- Result: parameters list
Change an object:
- Parameters:
- sok - the parameter must not be empty, generally "yes".
- elid - unique identifier ("id" element of "survey" function)
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
- newname - Наименование новой анкеты.
Function: survey.enable
Parameters:
- elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "id" element of "survey" function.
Result: successful operation or error message
Function: survey.disable
Parameters:
- elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "id" element of "survey" function.
Result: successful operation or error message
Function: survey.question
Parameters:
- elid - unique identifier ("id" element of "survey" function).
Result: elements list
- id - .
- position - Позиция.
- name - Вопрос.
- condition - Условие.
Function: survey.question.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 "survey" function).
- elid - unique identifier ("id" element of "survey.question" 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 "survey" 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 "survey" function).
- elid - unique identifier ("id" element of "survey.question" function)
- additional query parameters ...
- Result: successfull operation or error message
The list object's parameters or additional query parameters (see above):
- name - Вопрос.
- position - Позиция в анкете.
- answertype - Сколько вариантов ответа.
- commentrows - Строк в поле комментария.
- cquestion - Вопрос условие. If the null value is selected the parameters are denied: 'canswer'
- canswer - Ответ условие.
Function: survey.question.delete
Parameters:
- plid - parent list unique identifier ("id" element of "survey" function).
- elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "id" element of "survey.question" function.
Result: successful operation or error message
Function: survey.question.answer
Parameters:
- elid - unique identifier ("id" element of "survey.question" function).
Result: elements list
- id - .
- position - Позиция.
- name - Ответ.
Function: survey.question.answer.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 "survey.question" function).
- elid - unique identifier ("id" element of "survey.question.answer" 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 "survey.question" 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 "survey.question" function).
- elid - unique identifier ("id" element of "survey.question.answer" function)
- additional query parameters ...
- Result: successfull operation or error message
The list object's parameters or additional query parameters (see above):
- name - Ответ.
- position - Позиция в анкете.
Function: survey.question.answer.delete
Parameters:
- plid - parent list unique identifier ("id" element of "survey.question" function).
- elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "id" element of "survey.question.answer" function.
Result: successful operation or error message
Function: survey.question.answer.concat
- name - Новый текст ответа.
- position - Позиция в анкете.
Function: survey.question.answer.accounts
Parameters:
- elid - unique identifier ("id" element of "survey.question.answer" function).
Result: elements list
- account - Клиент.
- cdate - Дата ответа.
Function: survey.question.comments
Parameters:
- elid - unique identifier ("id" element of "survey.question" function).
Result: elements list
- account - Клиент.
- comment - Комментарий.
- cdate - Добавлен.
Function: survey.condition
Parameters:
- elid - unique identifier ("id" element of "survey" function).
Result: elements list
- id - .
- name - Условие.
- active - .
Function: survey.condition.add
- ctype - Тип условия.
Function: survey.condition.edit
Function: survey.condition.delete
Parameters:
- plid - parent list unique identifier ("id" element of "survey" function).
- elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "id" element of "survey.condition" function.
Result: successful operation or error message
Function: survey.condition.enable
Parameters:
- plid - parent list unique identifier ("id" element of "survey" function).
- elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "id" element of "survey.condition" function.
Result: successful operation or error message
Function: survey.condition.disable
Parameters:
- plid - parent list unique identifier ("id" element of "survey" function).
- elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "id" element of "survey.condition" function.
Result: successful operation or error message
Function: survey.condition.trylist
Result: the list of elements
- id - .
- name - .
Email advertisement
Function: admail
Result: the list of elements
- id - .
- name - Название сообщения.
- start - Начало действия.
- end - Окончание действия.
- priority - Приоритет.
Function: admail.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 "admail" 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 "admail" function)
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
- name - Название.
- start - Начало действия.
- end - Окончание действия.
- priority - Приоритет.
- msg - Текст по умолчанию (английский язык).
Function: admail.delete
Parameters:
- elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "id" element of "admail" function.
Result: successful operation or error message
Function: admail.project
Parameters:
- elid - unique identifier ("id" element of "admail" function).
Result: elements list
- id - .
- name - Название.
- active - .
Function: admail.project.enable
Parameters:
- plid - parent list unique identifier ("id" element of "admail" function).
- elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "id" element of "admail.project" function.
Result: successful operation or error message
Function: admail.project.disable
Parameters:
- plid - parent list unique identifier ("id" element of "admail" function).
- elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "id" element of "admail.project" function.
Result: successful operation or error message
Function: admail.price
Parameters:
- elid - unique identifier ("id" element of "admail" function).
Result: elements list
- id - .
- name - Название.
- project - Проект.
- active - .
Function: admail.price.enable
Parameters:
- plid - parent list unique identifier ("id" element of "admail" function).
- elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "id" element of "admail.price" function.
Result: successful operation or error message
Function: admail.price.disable
Parameters:
- plid - parent list unique identifier ("id" element of "admail" function).
- elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "id" element of "admail.price" function.
Result: successful operation or error message
Products
Service packages
Function: pricelist
Result: the list of elements
- id - .
- name - .
- type - Item type .
- project - .
- price - Price.
- billtype - Billing type.
- active - Available for order.
- limited - Available for special account groups only .
Function: pricelist.create
The function is simultaneously used to view and change form's data
View data:
- Result: parameters list
Change the data:
- Parameters:
- sok - the parameter must not be empty, generally "yes".
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
- createperiod - Create order periods. (Optional parameter. To enable the option click "on".) Active parameter allows the use of the following parameters: 'pp1'
- periodprice - Enter the package recurrent fee .
- createcontent - Create all available add-ons (features). (Optional parameter. To enable the option click "on".)
- useservers - Use all associated servers. (Optional parameter. To enable the option click "on".)
Function: pricelist.clone
The function is simultaneously used to view and change object's parameters.
View object's parameters:
- Parameters:
- elid - unique identifier ("id" element of "pricelist" function)
- Result: parameters list
Change an object:
- Parameters:
- sok - the parameter must not be empty, generally "yes".
- elid - unique identifier ("id" element of "pricelist" function)
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
Function: pricelist.import
Function: pricelist.edit
The function is simultaneously used to view and change object's parameters.
View object's parameters:
- Parameters:
- elid - unique identifier ("id" element of "pricelist" function)
- Result: parameters list
Change an object:
- Parameters:
- sok - the parameter must not be empty, generally "yes".
- elid - unique identifier ("id" element of "pricelist" function)
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
- name - .
- internalname - Internal name.
- logintemplate - Login template.
- domaintemplate - Domain template .
- priority - Priority.
- price - Cost .
- setup - Setup fee.
- active - . (Optional parameter. To enable the option click "on".)
- restrictchange - . (Optional parameter. To enable the option click "on".)
- custom - . (Optional parameter. To enable the option click "on".)
- allowpostpaid - Renew if there are insufficient funds on personal account . (Optional parameter. To enable the option click "on".)
- servicekind - Kind of service.
- registrar - Registrar .
- pgroup - Package group.
- access - Access level .
- agreement - Service agreement.
- ownnsserver - Private second name server . (Optional parameter. To enable the option click "on".)
- orderlink - Order link .
- note - Notes.
Function: pricelist.delete
Parameters:
- elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "id" element of "pricelist" function.
Result: successful operation or error message
Function: pricelist.detail
Parameters:
- elid - unique identifier ("id" element of "pricelist" function).
Result: elements list
- id - .
- name - Name.
- rlimit - Add-on.
- price - Add-on price.
- active - Available for order .
Function: pricelist.detail.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 "pricelist" function).
- elid - unique identifier ("id" element of "pricelist.detail" 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 "pricelist" 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 "pricelist" function).
- elid - unique identifier ("id" element of "pricelist.detail" function)
- additional query parameters ...
- Result: successfull operation or error message
The list object's parameters or additional query parameters (see above):
- type - Type.
- billtype - Billing type. If the 3 value is selected the parameters are allowed to use: 'addononlyactive' and the parameters are denied: 'minperiod'
- addontype - Value type. If the 4 value is selected the parameters are allowed to use: 'enum','enumval','rlim1','addonmax','addonstep','setuppayonce','measure' and the parameters are denied: 'rlim2','price','unlimitprice'
- addonstattype - Count exceeded usage .
- addonstatcomparison - If there are several parameters .
- addonstatcalculation - The price is specified .
- addononlyactive - Only for active service . (Optional parameter. To enable the option click "on".)
- internalname - Internal name .
- addonenum - Enumeration.
- addonenumval - Included value.
- addonmeasure - Unit of measure.
- rlimit - Included limit.
- rlimitbool - Included limit. (Optional parameter. To enable the option click "on".)
- addonstep - Step .
- addonmax - Maximum value.
- price - Add-on price.
- unlimitprice - Cost of unlimited service.
- minperiodlen - Minimal order period.
- minperiodtype - Minimal order period.
- setup - Setup fee.
- setuppayonce - Do not multiple by the number . (Optional parameter. To enable the option click "on".)
- priority - Priority .
- allowpostpaid - Post-paid . (Optional parameter. To enable the option click "on".)
- manualprocessing - Manual processing . (Optional parameter. To enable the option click "on".)
- trialdiscount - Do not count during the trial period . (Optional parameter. To enable the option click "on".)
- manualname - Random name . (Optional parameter. To enable the option click "on".)
- name - .
Function: pricelist.detail.delete
Parameters:
- plid - parent list unique identifier ("id" element of "pricelist" function).
- elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "id" element of "pricelist.detail" function.
Result: successful operation or error message
Function: pricelist.detail.enum
Parameters:
- elid - unique identifier ("id" element of "pricelist.detail" function).
Result: elements list
- id - .
- name - .
- price - Price.
- setup - Setup fee .
Function: pricelist.detail.enum.edit
The function is simultaneously used to view and change object's parameters.
View objects parameters:
- Parameters:
- plid - parent list unique identifier ("id" element of "pricelist.detail" function).
- elid - unique identifier ("id" element of "pricelist.detail.enum" function)
- Result: parameters list
Change an object:
- Parameters:
- sok - the parameter must not be empty, generally "yes".
- plid - parent list unique identifier ("id" element of "pricelist.detail" function).
- elid - unique identifier ("id" element of "pricelist.detail.enum" function)
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
- price - Price.
- setup - Setup fee .
Function: pricelist.detail.import
- from - Copy from.
- force - Replace existing values. (Optional parameter. To enable the option click "on".)
Function: pricelist.detail.enable
Parameters:
- plid - parent list unique identifier ("id" element of "pricelist" function).
- elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "id" element of "pricelist.detail" function.
Result: successful operation or error message
Function: pricelist.detail.disable
Parameters:
- plid - parent list unique identifier ("id" element of "pricelist" function).
- elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "id" element of "pricelist.detail" function.
Result: successful operation or error message
Function: pricelist.period
Parameters:
- elid - unique identifier ("id" element of "pricelist" function).
Result: elements list
- id - .
- name - .
- price - Period price.
- priority - Priority .
- active - Available for order .
Function: pricelist.period.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 "pricelist" function).
- elid - unique identifier ("id" element of "pricelist.period" 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 "pricelist" 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 "pricelist" function).
- elid - unique identifier ("id" element of "pricelist.period" function)
- additional query parameters ...
- Result: successfull operation or error message
The list object's parameters or additional query parameters (see above):
- name - Period name.
- pertype - Unit of measure . If the unlimited value is selected the parameters are denied: 'pl'
- plength - Period length.
- price - Period price.
- prolongprice - Renewal cost .
- priority - Priority .
- active - . (Optional parameter. To enable the option click "on".)
- orderlink - Order link .
Function: pricelist.period.delete
Parameters:
- plid - parent list unique identifier ("id" element of "pricelist" function).
- elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "id" element of "pricelist.period" function.
Result: successful operation or error message
Function: pricelist.period.import
- from - Copy from.
- force - Replace existing values. (Optional parameter. To enable the option click "on".)
Function: pricelist.period.enable
Parameters:
- plid - parent list unique identifier ("id" element of "pricelist" function).
- elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "id" element of "pricelist.period" function.
Result: successful operation or error message
Function: pricelist.period.disable
Parameters:
- plid - parent list unique identifier ("id" element of "pricelist" function).
- elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "id" element of "pricelist.period" function.
Result: successful operation or error message
Function: pricelist.server
Parameters:
- elid - unique identifier ("id" element of "pricelist" function).
Result: elements list
- id - .
- name - Server name.
- active - Enabled.
Function: pricelist.server.enable
Parameters:
- plid - parent list unique identifier ("id" element of "pricelist" function).
- elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "id" element of "pricelist.server" function.
Result: successful operation or error message
Function: pricelist.server.disable
Parameters:
- plid - parent list unique identifier ("id" element of "pricelist" function).
- elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "id" element of "pricelist.server" function.
Result: successful operation or error message
Package groups
Function: productgroup
Result: the list of elements
- id - .
- name - .
Function: productgroup.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 "productgroup" 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 "productgroup" function)
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
Function: productgroup.delete
Parameters:
- elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "id" element of "productgroup" function.
Result: successful operation or error message
Item types
Function: itemtype
Result: the list of elements
- id - .
- name - .
- intname - Internal name.
Function: itemtype.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 "itemtype" 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 "itemtype" function)
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
- name - .
- intname - Internal name.
- module - Processing module.
- suspendperiod - Auto-suspension period.
- deleteordered - Delete due orders in .
- needserver - Server required . (Optional parameter. To enable the option click "on".)
- restrictdelete - Forbid customers to delete . (Optional parameter. To enable the option click "on".)
- requeryphone - Phone validation required . (Optional parameter. To enable the option click "on".) The parameter may vary depending on feature fraud.
- ownmenu - Menu item . (Optional parameter. To enable the option click "on".)
- prolongprice - Renew at special price . (Optional parameter. To enable the option click "on".)
- trialtype - Trial version .
- priority - Priority .
- expensetemplate - Expense name template .
- divexpense - Split expenses. (Optional parameter. To enable the option click "on".)
- divbypricegroup - Divide by package groups . (Optional parameter. To enable the option click "on".)
Function: itemtype.delete
Parameters:
- elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "id" element of "itemtype" function.
Result: successful operation or error message
Function: itemtype.addon
Parameters:
- elid - unique identifier ("id" element of "itemtype" function).
Result: elements list
- id - .
- name - .
- intname - Internal Name.
- active - Add-on is available for the selected item type.
Function: itemtype.addon.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 "itemtype" function).
- elid - unique identifier ("id" element of "itemtype.addon" 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 "itemtype" 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 "itemtype" function).
- elid - unique identifier ("id" element of "itemtype.addon" function)
- additional query parameters ...
- Result: successfull operation or error message
The list object's parameters or additional query parameters (see above):
- name - .
- intname - Internal name.
- subtype - Subtype.
- checkfeature - Check feature .
Function: itemtype.addon.delete
Parameters:
- plid - parent list unique identifier ("id" element of "itemtype" function).
- elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "id" element of "itemtype.addon" function.
Result: successful operation or error message
Function: itemtype.addon.enable
Parameters:
- plid - parent list unique identifier ("id" element of "itemtype" function).
- elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "id" element of "itemtype.addon" function.
Result: successful operation or error message
Function: itemtype.addon.disable
Parameters:
- plid - parent list unique identifier ("id" element of "itemtype" function).
- elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "id" element of "itemtype.addon" function.
Result: successful operation or error message
Function: itemtype.addon.instruction
The function is simultaneously used to view and change object's parameters.
View objects parameters:
- Parameters:
- plid - parent list unique identifier ("id" element of "itemtype" function).
- elid - unique identifier ("id" element of "itemtype.addon" function)
- Result: parameters list
Change an object:
- Parameters:
- sok - the parameter must not be empty, generally "yes".
- plid - parent list unique identifier ("id" element of "itemtype" function).
- elid - unique identifier ("id" element of "itemtype.addon" function)
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
- instruction_en - Instruction (default language) .
Function: itemtype.param
Parameters:
- elid - unique identifier ("id" element of "itemtype" function).
Result: elements list
- id - .
- name - .
- intname - Internal name.
Function: itemtype.param.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 "itemtype" function).
- elid - unique identifier ("id" element of "itemtype.param" 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 "itemtype" 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 "itemtype" function).
- elid - unique identifier ("id" element of "itemtype.param" function)
- additional query parameters ...
- Result: successfull operation or error message
The list object's parameters or additional query parameters (see above):
- name - .
- intname - Internal name.
- paramtype - Parameter type.
- paramaccess - Edit function .
- note - Description.
Function: itemtype.param.delete
Parameters:
- plid - parent list unique identifier ("id" element of "itemtype" function).
- elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "id" element of "itemtype.param" function.
Result: successful operation or error message
Kinds of services
Function: svrkind
Result: the list of elements
- id - .
- localname - Name .
Function: svrkind.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 "svrkind" 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 "svrkind" function)
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
- name - .
Function: svrkind.delete
Parameters:
- elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "id" element of "svrkind" function.
Result: successful operation or error message
Enumerations
Function: enumeration
Result: the list of elements
- name - The list element unique identifier
- id - .
- localname - Name.
Function: enumeration.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 ("name" element of "enumeration" 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 ("name" element of "enumeration" function)
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
- name - .
Function: enumeration.delete
Parameters:
- elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "name" element of "enumeration" function.
Result: successful operation or error message
Function: enumeration.item
Parameters:
- elid - unique identifier ("name" element of "enumeration" function).
Result: elements list
- id - .
- name - .
Function: enumeration.item.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 ("name" element of "enumeration" function).
- elid - unique identifier ("id" element of "enumeration.item" function)
- Result: object parameters list
Create an object:
- Parameters:
- sok - the parameter must not be empty, generally "yes".
- plid - parent list unique identifier ("name" element of "enumeration" 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 ("name" element of "enumeration" function).
- elid - unique identifier ("id" element of "enumeration.item" function)
- additional query parameters ...
- Result: successfull operation or error message
The list object's parameters or additional query parameters (see above):
- name - .
- internalname - Internal name.
Function: enumeration.item.delete
Parameters:
- plid - parent list unique identifier ("name" element of "enumeration" function).
- elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "id" element of "enumeration.item" function.
Result: successful operation or error message
Disk images
Function: diskimage
Result: the list of elements
- id - .
- name - .
Function: diskimage.edit
The function is simultaneously used to view and change object's parameters.
View object's parameters:
- Parameters:
- elid - unique identifier ("id" element of "diskimage" function)
- Result: parameters list
Change an object:
- Parameters:
- sok - the parameter must not be empty, generally "yes".
- elid - unique identifier ("id" element of "diskimage" function)
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
- name - .
- props - Properties .
- note - .
Function: diskimage.delete
Parameters:
- elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "id" element of "diskimage" function.
Result: successful operation or error message
Function: diskimage.pricelist
Parameters:
- elid - unique identifier ("id" element of "diskimage" function).
Result: elements list
- id - .
- name - Package .
- active - Allowed .
Function: diskimage.pricelist.enable
Parameters:
- plid - parent list unique identifier ("id" element of "diskimage" function).
- elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "id" element of "diskimage.pricelist" function.
Result: successful operation or error message
Function: diskimage.pricelist.disable
Parameters:
- plid - parent list unique identifier ("id" element of "diskimage" function).
- elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "id" element of "diskimage.pricelist" function.
Result: successful operation or error message
Service agreements
Function: agreement
Result: the list of elements
- id - .
- name - .
Function: agreement.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 "agreement" 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 "agreement" function)
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
- name - .
- msg_en - .
Function: agreement.delete
Parameters:
- elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "id" element of "agreement" function.
Result: successful operation or error message
Support
Trouble tickets
Function: tickets
Result: the list of elements
- id - The list element unique identifier
- ticketid - Код запроса.
- subject - Тема.
- account - Клиент.
- weight - Вес.
- delay - Задержка.
- replyuntil - Осталось.
- responsible - Отвечающий.
- project - .
- category - Категория.
- expenses - Расходы.
- uadmin - Пользователь не имеет администраторских прав.
- mail - Сообщение пришло по почте.
- att_love1 - Хороший клиент.
- att_hate1 - Конфликтный клиент.
- premium - Клиент имеет платную поддержку для данного продукта.
- premiumother - Клиент имеет платную поддержку на других продуктах.
- delayed - Отложен до .
Function: tickets.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 "tickets" 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 "tickets" function)
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
- lastmessage - Тема.
- subject - Тема.
- text - Новое сообщение.
- blockticket - . (Optional parameter. To enable the option click "on".)
- closeticket - . (Optional parameter. To enable the option click "on".)
- isinternal - . (Optional parameter. To enable the option click "on".)
- createexpense - . (Optional parameter. To enable the option click "on".)
- saveanswer - . (Optional parameter. To enable the option click "on".)
- viewcount - .
- blockclose - . (Optional parameter. To enable the option click "on".)
- delaycheck - . (Optional parameter. To enable the option click "on".) Active parameter allows the use of the following parameters: 'delayon','delaycheckto','delaycheckformat'
- delayon - .
- price - Стоимость.
- responsible - Ответственный отдел или пользователь.
- category - Категория.
- isdefaultresponder - Автоматически назначать мне запрос при поступлении новых сообщений. (Optional parameter. To enable the option click "on".)
- product - Продукты/услуги.
- productnote - Комментарий.
- accountnote - Комментарий.
Function: tickets.delete
Parameters:
- elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "id" element of "tickets" function.
Result: successful operation or error message
Function: tickets.unblock
Parameters:
- elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "id" element of "tickets" function.
Result: successful operation or error message
Function: tickets.setfilter
Function: tickets.listmessages
Parameters:
- elid - unique identifier ("id" element of "tickets" function).
Result: elements list
- id - .
- text - Текст сообщения.
- date - Дата сообщения.
- author - Автор.
- expens - Расходы.
Function: tickets.listmessages.edit
The function is simultaneously used to view and change object's parameters.
View objects parameters:
- Parameters:
- plid - parent list unique identifier ("id" element of "tickets" function).
- elid - unique identifier ("id" element of "tickets.listmessages" function)
- Result: parameters list
Change an object:
- Parameters:
- sok - the parameter must not be empty, generally "yes".
- plid - parent list unique identifier ("id" element of "tickets" function).
- elid - unique identifier ("id" element of "tickets.listmessages" function)
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
- message - Текст сообщения.
Function: splitticket
The function is simultaneously used to view and change object's parameters.
View objects parameters:
- Parameters:
- plid - parent list unique identifier ("id" element of "tickets" function).
- elid - unique identifier ("id" element of "tickets.listmessages" function)
- Result: parameters list
Change an object:
- Parameters:
- sok - the parameter must not be empty, generally "yes".
- plid - parent list unique identifier ("id" element of "tickets" function).
- elid - unique identifier ("id" element of "tickets.listmessages" function)
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
- subject - Тема для нового тикета.
Function: tickets.listmessages.delete
Parameters:
- plid - parent list unique identifier ("id" element of "tickets" function).
- elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "id" element of "tickets.listmessages" function.
Result: successful operation or error message
Function: tickets.su
All tickets
Function: alltickets
Result: the list of elements
- id - .
- subject - Тема.
- account - Клиент.
- datelast - Последнее сообщение.
- category - Категория.
- expenses - Расходы.
- mail - Сообщение пришло по почте.
- admin - Пользователь не имеет администраторских прав доступа.
Function: alltickets.edit
The function is simultaneously used to view and change object's parameters.
View object's parameters:
- Parameters:
- elid - unique identifier ("id" element of "alltickets" function)
- Result: parameters list
Change an object:
- Parameters:
- sok - the parameter must not be empty, generally "yes".
- elid - unique identifier ("id" element of "alltickets" function)
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
- subject - Тема.
- responsible - Передать отделу или администратору.
- accountnote - .
Function: alltickets.delete
Parameters:
- elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "id" element of "alltickets" function.
Result: successful operation or error message
Function: alltickets.setfilter
Function: alltickets.listmessages
Parameters:
- elid - unique identifier ("id" element of "alltickets" function).
Result: elements list
- id - .
- text - Текст сообщения.
- date - Дата написания.
- author - Автор.
- expens - Расходы.
Function: alltickets.listmessages.edit
The function is simultaneously used to view and change object's parameters.
View objects parameters:
- Parameters:
- plid - parent list unique identifier ("id" element of "alltickets" function).
- elid - unique identifier ("id" element of "alltickets.listmessages" function)
- Result: parameters list
Change an object:
- Parameters:
- sok - the parameter must not be empty, generally "yes".
- plid - parent list unique identifier ("id" element of "alltickets" function).
- elid - unique identifier ("id" element of "alltickets.listmessages" function)
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
- message - Текст сообщения.
Function: alltickets.listmessages.delete
Parameters:
- plid - parent list unique identifier ("id" element of "alltickets" function).
- elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "id" element of "alltickets.listmessages" function.
Result: successful operation or error message
Function: alltickets.su
Function: unknownmail
Result: the list of elements
- id - .
- subject - Тема.
- email - Почтовый ящик отправителя.
- cdate - Дата получения.
- toemail - Пришло на.
Function: unknownmail.edit
The function is simultaneously used to view and change object's parameters.
View object's parameters:
- Parameters:
- elid - unique identifier ("id" element of "unknownmail" function)
- Result: parameters list
Change an object:
- Parameters:
- sok - the parameter must not be empty, generally "yes".
- elid - unique identifier ("id" element of "unknownmail" function)
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
- email - Почтовый ящик отправителя.
- toemail - Пришло на.
- subject - Тема.
- message_text - Текст письма.
- reason - Причина блокировки.
- act - Действие. If the approve value is selected the parameters are allowed to use: 'account'
- account - Перенести к клиенту.
Function: unknownmail.delete
Parameters:
- elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "id" element of "unknownmail" function.
Result: successful operation or error message
Function: unknownmail.spam
Parameters:
- elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "id" element of "unknownmail" function.
Result: successful operation or error message
Announcements
Function: infoboard
Result: the list of elements
- id - .
- name - Название.
- sdate - Начало работ.
- cdate - Окончание работ.
- status - Состояние.
Function: infoboard.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 "infoboard" 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 "infoboard" function)
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
- name - Название.
- itype - Тип. If the server value is selected the parameters are allowed to use: 'server' and the parameters are denied: 'datacenter','project','client'
- datacenter - Датацентр.
- server - Сервер.
- project - .
- client - Клиенты. (One or more values space-delimited)
- sdate - Дата начала работ.
- stime - Время начала работ.
- cdate - Планируемая дата окончания работ.
- ctime - Планируемое время окончания работ.
- timezone - Часовой пояс.
- block - Блокирующее. (Optional parameter. To enable the option click "on".)
- msg_en - .
Function: infoboard.delete
Parameters:
- elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "id" element of "infoboard" function.
Result: successful operation or error message
Clients query
Function: callcustomer
Result: the list of elements
- account - The list element unique identifier
- name - Client .
- project - .
- city - City .
- lang - Language .
- balance - Balance of account .
- cdate - Latest update .
Function: callcustomer.edit
The function is simultaneously used to view and change object's parameters.
View object's parameters:
- Parameters:
- elid - unique identifier ("account" element of "callcustomer" function)
- Result: parameters list
Change an object:
- Parameters:
- sok - the parameter must not be empty, generally "yes".
- elid - unique identifier ("account" element of "callcustomer" function)
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
- remade - delay. (Optional parameter. To enable the option click "on".)
- remade_days - delay.
- accountnote - Comments .
- account - .
- interested - Interesting answer . (Optional parameter. To enable the option click "on".)
Function: callcustomer.delete
Parameters:
- elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "account" element of "callcustomer" function.
Result: successful operation or error message
Function: callcustomer.setfilter
Function: callcustomer.remade
Result: the list of elements
- account - The list element unique identifier
- name - Customer .
- project - .
- city - City .
- lang - Language .
- balance - Current balance of account .
- cdate - Add date .
- remade - Delayed .
Function: callcustomer.edit
The function is simultaneously used to view and change object's parameters.
View object's parameters:
- Parameters:
- elid - unique identifier ("account" element of "callcustomer.remade" function)
- Result: parameters list
Change an object:
- Parameters:
- sok - the parameter must not be empty, generally "yes".
- elid - unique identifier ("account" element of "callcustomer.remade" function)
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
- remade - delay. (Optional parameter. To enable the option click "on".)
- remade_days - delay.
- accountnote - Comments .
- account - .
- interested - Interesting answer . (Optional parameter. To enable the option click "on".)
Function: callcustomer.delete
Parameters:
- elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "account" element of "callcustomer.remade" function.
Result: successful operation or error message
Function: callcustomer.remade.setfilter
Function: callcustomer.remade.su
Function: callcustomer.su
Tickets estimator
Function: ticketestimator
Result: the list of elements
- id - .
- name - .
- t_count - Количество тикетов.
Function: ticketestimator.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 "ticketestimator" 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 "ticketestimator" function)
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
- name - Наименование.
- term - Условие отбора (SQL).
Function: ticketestimator.delete
Parameters:
- elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "id" element of "ticketestimator" function.
Result: successful operation or error message
Function: ticketestimator.tickets
Parameters:
- elid - unique identifier ("id" element of "ticketestimator" function).
Result: elements list
- id - .
- subject - Тема.
- account - Клиент.
- createdate - Дата добавления.
- project - Проект.
- category - Категория.
- expenses - Расходы.
- datelast - Последнее сообщение.
- mail - Сообщение пришло по почте.
- att_love1 - Хороший клиент.
- att_hate1 - Конфликтный клиент.
Function: ticketestimator.tickets.edit
The function is simultaneously used to view and change object's parameters.
View objects parameters:
- Parameters:
- plid - parent list unique identifier ("id" element of "ticketestimator" function).
- elid - unique identifier ("id" element of "ticketestimator.tickets" function)
- Result: parameters list
Change an object:
- Parameters:
- sok - the parameter must not be empty, generally "yes".
- plid - parent list unique identifier ("id" element of "ticketestimator" function).
- elid - unique identifier ("id" element of "ticketestimator.tickets" function)
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
- subject - Тема.
- score - Тема.
- text - Новое сообщение.
- isinternal - . (Optional parameter. To enable the option click "on".)
- forward - . (Optional parameter. To enable the option click "on".) Active parameter allows the use of the following parameters: 'email'
- responsible - Ответственный отдел или пользователь.
- email - E-mail адрес.
- accountnote - Комментарий.
Function: ticketestimator.tickets.delete
Parameters:
- plid - parent list unique identifier ("id" element of "ticketestimator" function).
- elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "id" element of "ticketestimator.tickets" function.
Result: successful operation or error message
Function: ticketestimator.tickets.setfilter
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
Function: supportcategories.ticketweight
Result: the list of elements
- id - .
- project - .
- weight - Вес.
- name - .
Function: supportcategories.ticketweight.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.ticketweight" 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.ticketweight" function)
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
- type - Условие. If the 1 value is selected the parameters are allowed to use: 'comparison','amount','project' and the parameters are denied: 'lifetime','attitude','price','addon','enumitem','partner','client','category'
- project - .
- partner - Партнер.
- client - Код клиента.
- category - Категория.
- comparison - Сравнение.
- lifetime - Период.
- periodtype - Период.
- amount - Сумма.
- attitude - Характеристика.
- price - Тариф.
- addon - Деталь. If the null value is selected the parameters are denied: 'enumitem'
- enumitem - Значение.
- weight - Вес.
- needschedule - Особый регламент. (Optional parameter. To enable the option click "on".)
- schedule - Регламент.
Function: supportcategories.ticketweight.delete
Parameters:
- elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "id" element of "supportcategories.ticketweight" function.
Result: successful operation or error message
Answer templates
Function: anstempl
Result: the list of elements
- id - .
- message - Сообщение.
- project - Проект.
- type - Тип шаблона.
- admingroup - Отдел.
Function: anstempl.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 "anstempl" 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 "anstempl" function)
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
- message - .
- priority - Приоритет.
- project - Проект:.
- type - Тип шаблона:.
- shared - Общий. (Optional parameter. To enable the option click "on".) Active parameter allows the use of the following parameters: 'admingroup'
- admingroup - Отдел.
Function: anstempl.delete
Parameters:
- elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "id" element of "anstempl" function.
Result: successful operation or error message
Gateways
Function: supportgate
Result: the list of elements
- id - .
- type - Тип шлюза.
- data - Идентификатор.
Function: supportgate.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 "supportgate" 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 "supportgate" function)
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
- type - Тип шлюза. If the mail value is selected the parameters are allowed to use: 'email'
- project - .
- category - Категория.
- email - Почтовый ящик.
Function: supportgate.delete
Parameters:
- elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "id" element of "supportgate" function.
Result: successful operation or error message
База знаний
Function: kb
Result: the list of elements
- name - Категория.
- qa - Статья.
Function: kb.item
Parameters:
- elid - unique identifier ("id" element of "kb" function).
Result: elements list
- id - The list element unique identifier
- qa - Статья.
Telephone surveys
Function: callsurvey
Result: the list of elements
- surveyaccount - The list element unique identifier
- surveyname - Опрос.
- accountname - Клиент.
- city - Город.
- lang - Язык.
- balance - На балансе.
- appenddate - Добавлена.
Function: callsurvey.edit
The function is simultaneously used to view and change object's parameters.
View object's parameters:
- Parameters:
- elid - unique identifier ("surveyaccount" element of "callsurvey" function)
- Result: parameters list
Change an object:
- Parameters:
- sok - the parameter must not be empty, generally "yes".
- elid - unique identifier ("surveyaccount" element of "callsurvey" function)
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
- hide - . (Optional parameter. To enable the option click "on".)
- hide_days - .
- accountnote - Комментарий.
- lang - .
- goodanswer - Интересный ответ. (Optional parameter. To enable the option click "on".)
Function: callsurvey.delete
Parameters:
- elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "surveyaccount" element of "callsurvey" function.
Result: successful operation or error message
Function: callsurvey.setfilter
Function: callsurvey.hidden
Result: the list of elements
- surveyaccount - The list element unique identifier
- surveyname - Опрос.
- accountname - Клиент.
- city - Город.
- lang - Язык.
- balance - На балансе.
- appenddate - Добавлена.
- hidetill - Отложено до.
Function: callsurvey.edit
The function is simultaneously used to view and change object's parameters.
View object's parameters:
- Parameters:
- elid - unique identifier ("surveyaccount" element of "callsurvey.hidden" function)
- Result: parameters list
Change an object:
- Parameters:
- sok - the parameter must not be empty, generally "yes".
- elid - unique identifier ("surveyaccount" element of "callsurvey.hidden" function)
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
- hide - . (Optional parameter. To enable the option click "on".)
- hide_days - .
- accountnote - Комментарий.
- lang - .
- goodanswer - Интересный ответ. (Optional parameter. To enable the option click "on".)
Function: callsurvey.delete
Parameters:
- elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "surveyaccount" element of "callsurvey.hidden" function.
Result: successful operation or error message
Function: callsurvey.hidden.setfilter
Function: callsurvey.hidden.su
Function: callsurvey.su
Tools
Merge accounts
Function: joinaccount
The function is simultaneously used to view and change form's data
View data:
- Result: parameters list
Change the data:
- Parameters:
- sok - the parameter must not be empty, generally "yes".
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
- primacc - Primary account ID.
- slacc - Merging accounts ID.
Function: joinaccount.exec
The function is simultaneously used to view and change form's data
View data:
- Result: parameters list
Change the data:
- Parameters:
- sok - the parameter must not be empty, generally "yes".
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
Clone items
Function: cloneitem
The function is simultaneously used to view and change form's data
View data:
- Result: parameters list
Change the data:
- Parameters:
- sok - the parameter must not be empty, generally "yes".
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
- itemid - Item ID.
- accid - Account ID.
Function: cloneitem.setprice
The function is simultaneously used to view and change form's data
View data:
- Result: parameters list
Change the data:
- Parameters:
- sok - the parameter must not be empty, generally "yes".
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
- price - Package.
Function: cloneitem.setparam
The function is simultaneously used to view and change form's data
View data:
- Result: parameters list
Change the data:
- Parameters:
- sok - the parameter must not be empty, generally "yes".
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
- server - Server.
- period - Period.
Function: cloneitem.exec
The function is simultaneously used to view and change form's data
View data:
- Result: parameters list
Change the data:
- Parameters:
- sok - the parameter must not be empty, generally "yes".
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
Recalculation
Function: recalculateitem
The function is simultaneously used to view and change form's data
View data:
- Result: parameters list
Change the data:
- Parameters:
- sok - the parameter must not be empty, generally "yes".
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
- itemid - Item ID. (One or more values space-delimited)
- fromdate - Recalculate from the date.
- disablehistory - Do not count history . (Optional parameter. To enable the option click "on".)
Running tasks
Function: rerunoperation
Result: the list of elements
- item - Product ID .
- itname - Type .
- aname - Account .
- operation - Task type .
- time - Start time .
- nextstate - Required status .
- currentstate - Current status .
- trycount - Number of attempts .
- manproc - Processing type .
Function: rerunoperation.delete
Parameters:
- elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "item" element of "rerunoperation" function.
Result: successful operation or error message
Function: rerunoperation.try
Parameters:
- elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "item" element of "rerunoperation" function.
Result: successful operation or error message
Items import
Function: importitem
The function is simultaneously used to view and change form's data
View data:
- Result: parameters list
Change the data:
- Parameters:
- sok - the parameter must not be empty, generally "yes".
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
- remoteitem - Item ID .
- account - Client ID .
- itemtype - Item type .
- server - Associated server .
Function: importitem.exec
The function is simultaneously used to view and change form's data
View data:
- Result: parameters list
Change the data:
- Parameters:
- sok - the parameter must not be empty, generally "yes".
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
Directory
Countries
Function: country
Result: the list of elements
- id - .
- name - Name.
- iso2 - ISO code.
Function: country.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 "country" 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 "country" function)
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
- name - Name.
- iso2 - ISO code (2 char).
- phonecode - Phone code.
Function: country.delete
Parameters:
- elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "id" element of "country" function.
Result: successful operation or error message
Currencies
Function: currency
Result: the list of elements
- id - .
- name - .
- iso - ISO code.
- code - Numeric code.
- active - .
Function: currency.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 "currency" 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 "currency" function)
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
- name - .
- iso - Alphabetic code.
- code - Numeric code.
- active - Active. (Optional parameter. To enable the option click "on".)
Function: currency.delete
Parameters:
- elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "id" element of "currency" function.
Result: successful operation or error message
Function: currency.enable
Parameters:
- elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "id" element of "currency" function.
Result: successful operation or error message
Function: currency.disable
Parameters:
- elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "id" element of "currency" function.
Result: successful operation or error message
Function: currency.relation
Parameters:
- elid - unique identifier ("id" element of "currency" function).
Result: elements list
- name - .
- iso - Alphabetic code.
- rate - Current rate.
- rdate - Last date.
Function: currency.rate
Parameters:
- elid - unique identifier ("id" element of "currency.relation" function).
Result: elements list
- rdate - Date.
- rate - Currency rate.
Function: currency.rate.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 "currency.relation" function).
- elid - unique identifier ("rdate" element of "currency.rate" 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 "currency.relation" 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 "currency.relation" function).
- elid - unique identifier ("rdate" element of "currency.rate" function)
- additional query parameters ...
- Result: successfull operation or error message
The list object's parameters or additional query parameters (see above):
- rdate - Date.
- rate - Currency rate.
Function: currency.rate.delete
Parameters:
- plid - parent list unique identifier ("id" element of "currency.relation" function).
- elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "rdate" element of "currency.rate" function.
Result: successful operation or error message
Function: currency.rate.upload
- expr - Apply expression.
- auto - Autoupdate. (Optional parameter. To enable the option click "on".) Active parameter allows the use of the following parameters: 'atime'
- autotime - Update automatically at.
- upnow - Upload now. (Optional parameter. To enable the option click "on".) Active parameter allows the use of the following parameters: 'force','rdate'
- force - Replace existing currency rates . (Optional parameter. To enable the option click "on".)
- rdate - Start date .
Function: currency.update
Units of measure
Function: measure
Result: the list of elements
- id - .
- localname - Name .
Function: measure.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 "measure" 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 "measure" function)
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
- name - .
- intname - Internal name .
- lessmeasure - Has a relation to .
- relation - Relation .
Function: measure.delete
Parameters:
- elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "id" element of "measure" function.
Result: successful operation or error message
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.
Function: tld.delete
Parameters:
- elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "id" element of "tld" function.
Result: successful operation or error message
Search engines
Function: searchengines
Result: the list of elements
- id - .
- name - .
Function: searchengines.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 "searchengines" 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 "searchengines" function)
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
- name - .
- domain - Домен.
- param - Имя параметра.
Function: searchengines.delete
Parameters:
- elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "id" element of "searchengines" function.
Result: successful operation or error message
Software license keys
Function: softkey
Result: the list of elements
- id - .
- name - Ключ.
- pricelist - Тарифный план.
- period - Период.
- item - Код услуги.
Function: softkey.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 "softkey" 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 "softkey" function)
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
- pricelist - Тарифный план.
- period - Период.
- format - Формат.
- keydata - Ключи.
- name - Ключ.
Function: softkey.delete
Parameters:
- elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "id" element of "softkey" function.
Result: successful operation or error message
Server Statistics
Reports
Function: reportlist
Result: the list of elements
- id - The list element unique identifier
- name - .
Active sessions
Function: session
Result: the list of elements
- id - Session id.
- name - User name.
- lv_12 - .
- lv_11 - .
- lv_10 - .
- lv_7 - Server administrator.
- lv_6 - Reseller.
- lv_5 - User.
- lv_4 - User with access to shell.
- lv_3 - User with access to FTP.
- lv_2 - Mailbox.
- ip - IP-address.
- idle - Idle.
Function: session.delete
Parameters:
- elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "id" element of "session" function.
Result: successful operation or error message
Function: session.su
Background tasks
Function: longtask
Result: the list of elements
- sname - Script name .
- pid - PID-file .
- queue - Queue name .
- queue_id - Number in the queue .
- ok - The task was successfully processed .
- error - Failed to process the task .
- inqueue - Task in the queue .
- running - In progress .
Function: longtask.edit
The function is simultaneously used to view and change object's parameters.
View object's parameters:
- Parameters:
- elid - unique identifier ("pid" element of "longtask" function)
- Result: parameters list
Change an object:
- Parameters:
- sok - the parameter must not be empty, generally "yes".
- elid - unique identifier ("pid" element of "longtask" function)
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
- sname - Script name .
- pid - PID-file .
- queue - Queue name .
- queue_id - Number in the queue.
- params - Additional information .
Function: longtask.delete
Parameters:
- elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "pid" element of "longtask" function.
Result: successful operation or error message
Action log
Function: journal
Result: the list of elements
- id - The list element unique identifier
- time - Time.
- user - User.
- ip - Remote IP-address.
- funcname - Function.
Function: journal.edit
The function is simultaneously used to view and change object's parameters.
View object's parameters:
- Parameters:
- elid - unique identifier ("id" element of "journal" function)
- Result: parameters list
Change an object:
- Parameters:
- sok - the parameter must not be empty, generally "yes".
- elid - unique identifier ("id" element of "journal" function)
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
- time - Time.
- user - User.
- ip - Remote IP-address.
- funcname - Function.
- params - Parameters.
SMS log
Function: smsqueue
Result: the list of elements
- id - .
- phone - Телефон.
- message - Сообщение.
- account - Клиент.
- user - Пользователь.
- project - Проект.
- type - Тип.
- status - Статус.
- addtime - Время добавления.
Function: smsqueue.edit
The function is simultaneously used to view and change object's parameters.
View object's parameters:
- Parameters:
- elid - unique identifier ("id" element of "smsqueue" function)
- Result: parameters list
Change an object:
- Parameters:
- sok - the parameter must not be empty, generally "yes".
- elid - unique identifier ("id" element of "smsqueue" function)
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
- phone - Номер телефона.
- message - Сообщение.
- status - Статус.
Function: smsqueue.delete
Parameters:
- elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "id" element of "smsqueue" function.
Result: successful operation or error message
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
Certificate Authorities
Function: certauth
Result: the list of elements
- id - .
- name - .
Function: certauth.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 "certauth" 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 "certauth" function)
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
- name - . If the manual value is selected the parameters are allowed to use: 'admingroup' and the parameters are denied: 'resellerid','usr','pwd','apiurl','partnercode','ipaddr','usedemo','handle'
- admingroup - Responsible department.
- username - Username.
- resellerid - Reseller ID.
- password - Password.
- handle - Handle.
- apiurl - API URL address .
- partnercode - PartnerCode.
- ipaddr - IP-address .
- usedemo - Demo . (Optional parameter. To enable the option click "on".)
Function: certauth.delete
Parameters:
- elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "id" element of "certauth" function.
Result: successful operation or error message
Function: certauth.templates
Parameters:
- elid - unique identifier ("id" element of "certauth" function).
Result: elements list
- id - .
- name - .
Function: certauth.templates.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 "certauth" function).
- elid - unique identifier ("id" element of "certauth.templates" 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 "certauth" 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 "certauth" function).
- elid - unique identifier ("id" element of "certauth.templates" function)
- additional query parameters ...
- Result: successfull operation or error message
The list object's parameters or additional query parameters (see above):
- name - .
- certtype - Certificate type .
- showprop - Properties . (Optional parameter. To enable the option click "on".) Active parameter allows the use of the following parameters: 'wildcard','orginfo','extvalid','longkey','idn'
- wildcard - Multiple subdomains . (Optional parameter. To enable the option click "on".)
- orginfo - Organization information . (Optional parameter. To enable the option click "on".)
- extvalid - Extended verification . (Optional parameter. To enable the option click "on".)
- longkey - 2048-bit CSR. (Optional parameter. To enable the option click "on".)
- idn - IDN. (Optional parameter. To enable the option click "on".)
Function: certauth.templates.delete
Parameters:
- plid - parent list unique identifier ("id" element of "certauth" function).
- elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "id" element of "certauth.templates" function.
Result: successful operation or error message
Function: certauth.settings
- customopen - . (Optional parameter. To enable the option click "on".)
- adminticket - . (Optional parameter. To enable the option click "on".)
Datacenters
Function: datacenter
Result: the list of elements
- id - .
- name - .
Function: datacenter.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 "datacenter" 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 "datacenter" function)
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
- name - .
- priority - Priority .
Function: datacenter.delete
Parameters:
- elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "id" element of "datacenter" function.
Result: successful operation or error message
Servers
Function: server
Result: the list of elements
- id - .
- name - .
- datacenter - Datacenter.
- cpmodule - Control panel.
- statdate - Statistics.
- usage - Usage. Attributes :
- used - The used number.
- limit - Max value limitation
- loading - Load.
- active - Enabled.
- monitor - The server monitoring is active .
Function: server.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 "server" 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 "server" function)
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
- datacenter - Datacenter.
- cpmodule - Control panel. If the cpmanual value is selected the parameters are denied: 's1','s2','s3'
- name - Server name.
- url - Control panel URL .
- username - User .
- password - Password.
- manualcontact - Administrative contact .
- rlimit - Maximum number of customers .
- active - Enable for new orders . (Optional parameter. To enable the option click "on".)
- monitor - Monitoring . (Optional parameter. To enable the option click "on".) The parameter may vary depending on feature svrmonitor.
- config - .
- prolong - Renewal . (Optional parameter. To enable the option click "on".)
- changeparam - Edit parameters . (Optional parameter. To enable the option click "on".)
- sendtask - Error notifications . (Optional parameter. To enable the option click "on".)
Function: server.delete
Parameters:
- elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "id" element of "server" function.
Result: successful operation or error message
Function: server.pricelist
Parameters:
- elid - unique identifier ("id" element of "server" function).
Result: elements list
- id - .
- name - Package.
- project - .
- active - Enabled.
Function: server.pricelist.enable
Parameters:
- plid - parent list unique identifier ("id" element of "server" function).
- elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "id" element of "server.pricelist" function.
Result: successful operation or error message
Function: server.pricelist.disable
Parameters:
- plid - parent list unique identifier ("id" element of "server" function).
- elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "id" element of "server.pricelist" function.
Result: successful operation or error message
Function: server.statloading
Parameters:
- elid - unique identifier ("id" element of "server" function).
Result: elements list
- statdate - Date.
- cpu - CPU (% used).
- mem - RAM (% used).
- diskbusy - Disk space (% used).
- disk - Disk space (% used).
Function: server.getconfig
Parameters:
- elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "id" element of "server" function.
Result: successful operation or error message
Function: server.partner
Parameters:
- elid - unique identifier ("id" element of "server" function).
Result: elements list
- id - .
- name - Partner .
- active - Enabled .
Function: server.partner.enable
Parameters:
- plid - parent list unique identifier ("id" element of "server" function).
- elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "id" element of "server.partner" function.
Result: successful operation or error message
Function: server.partner.disable
Parameters:
- plid - parent list unique identifier ("id" element of "server" function).
- elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "id" element of "server.partner" function.
Result: successful operation or error message
Fraud protection
Function: fraudconf
The function is simultaneously used to view and change form's data
View data:
- Result: parameters list
Change the data:
- Parameters:
- sok - the parameter must not be empty, generally "yes".
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
- module - .
Function: fraudparam
Function: frauditemtype
The function is simultaneously used to view and change form's data
View data:
- Result: parameters list
Change the data:
- Parameters:
- sok - the parameter must not be empty, generally "yes".
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
SMS gateway
Function: smsgate
The function is simultaneously used to view and change form's data
View data:
- Result: parameters list
Change the data:
- Parameters:
- sok - the parameter must not be empty, generally "yes".
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
- module - Провайдер СМС шлюза.
Other Settings
Features
Function: feature
Result: the list of elements
- name - Name.
- active - Active .
Function: feature.enable
Parameters:
- elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "name" element of "feature" function.
Result: successful operation or error message
Function: feature.disable
Parameters:
- elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "name" element of "feature" function.
Result: successful operation or error message
Plug-ins
Function: plugin
Result: the list of elements
- name - Plug-in name .
- desc - Brief description .
- version - Version .
- bad - The plug-in failed due to errors in its description. .
- newver - .
Function: plugin.collection
Result: the list of elements
- name - Plug-in name .
- desc - Description .
- version - Version .
- author - Author .
Function: plugin.install
The function is simultaneously used to view and change object's parameters.
View object's parameters:
- Parameters:
- elid - unique identifier ("name" element of "plugin.collection" function)
- Result: parameters list
Change an object:
- Parameters:
- sok - the parameter must not be empty, generally "yes".
- elid - unique identifier ("name" element of "plugin.collection" function)
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
- agree - I was warned about consequences of my actions . (Optional parameter. To enable the option click "on".)
Function: plugin.info
The function is simultaneously used to view and change object's parameters.
View object's parameters:
- Parameters:
- elid - unique identifier ("name" element of "plugin.collection" function)
- Result: parameters list
Change an object:
- Parameters:
- sok - the parameter must not be empty, generally "yes".
- elid - unique identifier ("name" element of "plugin.collection" function)
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
- description - Detailed description .
- interpretator - Programming language .
- require - Required modules .
- author - Author .
- contact - Contact information .
Function: plugin.info
The function is simultaneously used to view and change object's parameters.
View object's parameters:
- Parameters:
- elid - unique identifier ("name" element of "plugin" function)
- Result: parameters list
Change an object:
- Parameters:
- sok - the parameter must not be empty, generally "yes".
- elid - unique identifier ("name" element of "plugin" function)
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
- description - Detailed description .
- interpretator - Programming language .
- require - Required modules .
- author - Author .
- contact - Contact information .
Function: plugin.update
Function: plugin.delete
Parameters:
- elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "name" element of "plugin" function.
Result: successful operation or error message
Function: plugin.source
Result: the list of elements
- url - Source URL .
Function: plugin.source.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 ("url" element of "plugin.source" 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 ("url" element of "plugin.source" function)
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
- url - Source URL .
Function: plugin.source.delete
Parameters:
- elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "url" element of "plugin.source" function.
Result: successful operation or error message
Function: plugin.source.refresh
Parameters:
- elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "url" element of "plugin.source" function.
Result: successful operation or error message
Locales
Function: locale
Result: the list of elements
- id - .
- name - .
- langcode - Code .
Function: locale.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 "locale" 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 "locale" function)
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
- name - Locale name.
- langcode - Language code.
Function: locale.delete
Parameters:
- elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "id" element of "locale" function.
Result: successful operation or error message
Function: locale.messages
Parameters:
- elid - unique identifier ("id" element of "locale" function).
Result: elements list
- name - Name.
- defmsg - Default message.
- trmsg - Message translation .
Function: locale.messages.edit
The function is simultaneously used to view and change object's parameters.
View objects parameters:
- Parameters:
- plid - parent list unique identifier ("id" element of "locale" function).
- elid - unique identifier ("name" element of "locale.messages" function)
- Result: parameters list
Change an object:
- Parameters:
- sok - the parameter must not be empty, generally "yes".
- plid - parent list unique identifier ("id" element of "locale" function).
- elid - unique identifier ("name" element of "locale.messages" function)
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
- defmsg - Message.
- trmsg - Messages translation .
Brand settings
Function: brand
The function is simultaneously used to view and change form's data
View data:
- Result: parameters list
Change the data:
- Parameters:
- sok - the parameter must not be empty, generally "yes".
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
- site - Link to your web site (e.g. http://my-hosting-company.com).
- mainlogo - .
- loginlogo - .
- mobilelogo - .
- favicon - .
- reset - Reset all the branding settings . (Optional parameter. To enable the option click "on".)
- h - Hue .
- s - Saturation .
- l - Brightness .
Global settings
Function: policy
The function is simultaneously used to view and change form's data
View data:
- Result: parameters list
Change the data:
- Parameters:
- sok - the parameter must not be empty, generally "yes".
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
- zeroexpense - . (Optional parameter. To enable the option click "on".)
- showdeleted - . (Optional parameter. To enable the option click "on".)
- fastinvoice - . (Optional parameter. To enable the option click "on".)
- autogenaccname - . (Optional parameter. To enable the option click "on".)
- delaccount - . (Optional parameter. To enable the option click "on".)
- noimportdomainaccount - . (Optional parameter. To enable the option click "on".)
- uniqueemail - . (Optional parameter. To enable the option click "on".)
- senddocdomain - . (Optional parameter. To enable the option click "on".)
- restrictdelautocr - . (Optional parameter. To enable the option click "on".)
- deletemanualsuspend - . (Optional parameter. To enable the option click "on".)
- billexpire - Low balance notification .
- itemexpire - Service suspension notification .
- pdfconverter - Path to the HTML2PDF converter file . The parameter may vary depending on feature svrpdfutil.
- maxcountgroupdomain - Available domains limit .
- defaultcountry - Default country.
- envelope - Envelope templates .
- receiving - Delivery and Acceptance certificate template .
- return - Equipment return certificate template .
- crmdepartment - CRM department . The parameter may vary depending on feature svrcrm.
- pperson - Payer status . (Optional parameter. To enable the option click "on".)
- pcompany - Payer status . (Optional parameter. To enable the option click "on".)
- psoleproprietor - Payer status . (Optional parameter. To enable the option click "on".)
- remoteclient - . (Optional parameter. To enable the option click "on".) The parameter may vary depending on feature svrrsupport.
- rlogin - Login. The parameter may vary depending on feature svrrsupport.
- rpasswd - Password. The parameter may vary depending on feature svrrsupport.
- rurl - URL. The parameter may vary depending on feature svrrsupport.
- nodefaultresponder - Do not assign tickets automatically . (Optional parameter. To enable the option click "on".)
- nosendtoresponder - Do not send a new message notification. (Optional parameter. To enable the option click "on".)
- ticketautoclose - . (Optional parameter. To enable the option click "on".) Active parameter allows the use of the following parameters: 'ticketautocloseperiod'
- ticketautocloseperiod - within .
- active_tickets_notify - New trouble tickets notifications for administrators . (Optional parameter. To enable the option click "on".)
- hideticketrouting - Number of ticket redirects .
- supportsatisfaction - Customer support satisfaction.
If the ticket_support_satisfaction value is selected the parameters are allowed to use: 'supportsatisfactionperiod' and the parameters are denied: 'supportsatisfactiondate'
- supportsatisfactionperiod - in.
- supportsatisfactiondate - date.
- pw_small_letters - Lower-case letters . (Optional parameter. To enable the option click "on".)
- pw_large_letters - Upper-case letters . (Optional parameter. To enable the option click "on".)
- pw_figures - Figures . (Optional parameter. To enable the option click "on".)
- pw_spec_char - Special symbols .
- pw_length - Password length .
- usecaptcha - . (Optional parameter. To enable the option click "on".) Active parameter allows the use of the following parameters: 'captcha_publick_key','captcha_private_key'
- captcha_publick_key - reCAPTCHA Public Key.
- captcha_private_key - reCAPTCHA Private Key.
- sms_passwd_recovery - Password recovery via SMS . (Optional parameter. To enable the option click "on".) The parameter may vary depending on feature svrsmsservice. Active parameter allows the use of the following parameters: 'max_sms_per_period','sms_period_type'
- max_sms_per_period - Attempts . The parameter may vary depending on feature svrsmsservice.
- sms_period_type - Attempts . The parameter may vary depending on feature svrsmsservice.
Provider settings
Function: provideroptions
The function is simultaneously used to view and change form's data
View data:
- Result: parameters list
Change the data:
- Parameters:
- sok - the parameter must not be empty, generally "yes".
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
Global discounts
Function: globaldiscount
Result: the list of elements
- id - .
- name - .
- value - Value .
- period - Validity period .
- cname - Condition .
Function: globaldiscount.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 "globaldiscount" 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 "globaldiscount" function)
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
Function: globaldiscount.delete
Parameters:
- elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "id" element of "globaldiscount" function.
Result: successful operation or error message
Document templates
Function: doctempl
Result: the list of elements
- id - .
- name - Template name.
Function: doctempl.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 "doctempl" 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 "doctempl" function)
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
- name - Template name.
- source - Use base template .
- data - .
Function: doctempl.delete
Parameters:
- elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "id" element of "doctempl" function.
Result: successful operation or error message
Function: doctempl.usedefault
Parameters:
- elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "id" element of "doctempl" function.
Result: successful operation or error message
Message templates
Function: msgtempl
Result: the list of elements
- name - Template name.
- desc - Description.
Function: msgtempl.edit
The function is simultaneously used to view and change object's parameters.
View object's parameters:
- Parameters:
- elid - unique identifier ("name" element of "msgtempl" function)
- Result: parameters list
Change an object:
- Parameters:
- sok - the parameter must not be empty, generally "yes".
- elid - unique identifier ("name" element of "msgtempl" function)
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
- msg_en - .
- useforall - Enable for all customers . (Optional parameter. To enable the option click "on".) The parameter may vary depending on feature svrsmsservice.
Function: msgtempl.try
The function is simultaneously used to view and change object's parameters.
View object's parameters:
- Parameters:
- elid - unique identifier ("name" element of "msgtempl" function)
- Result: parameters list
Change an object:
- Parameters:
- sok - the parameter must not be empty, generally "yes".
- elid - unique identifier ("name" element of "msgtempl" function)
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
- msglang - Locale.
Function: msgtempl.sms.edit
Function: msgtempl.sms.try
Email notifications
Function: subscribe
Result: the list of elements
- name - Name .
- disabled - This notification is not active .
- smsenabled - This notification is active .
- smsdisabled - .
- smsenabledadmin - Enabled by administrator .
- smsdisabledadmin - Not available .
Function: subscribe.enable
Parameters:
- elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "name" element of "subscribe" function.
Result: successful operation or error message
Function: subscribe.disable
Parameters:
- elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "name" element of "subscribe" function.
Result: successful operation or error message
Function: subscribe.sms.enable
Parameters:
- elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "name" element of "subscribe" function.
Result: successful operation or error message
Function: subscribe.sms.disable
Parameters:
- elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "name" element of "subscribe" function.
Result: successful operation or error message
Favourites
Function: usermenu
Result: the list of elements
- name - The list element unique identifier
- ntitle - Name .
- favorite - The menu item is in your Favourites .
- popular - This menu item is often used .
Function: usermenu.enable
Parameters:
- elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "name" element of "usermenu" function.
Result: successful operation or error message
Function: usermenu.disable
Parameters:
- elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "name" element of "usermenu" function.
Result: successful operation or error message
General settings
Function: usrparam
The function is simultaneously used to view and change form's data
View data:
- Result: parameters list
Change the data:
- Parameters:
- sok - the parameter must not be empty, generally "yes".
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
- name - Username.
- email - E-mail for notifications .
- email - E-mail for notifications . The parameter may vary depending on feature billmgr.
- changed - Theme.
- theme - Theme.
- lang - Language.
- timezone - Time zone.
- passwd - Password.
- confirm - Re-enter password.
- atype - Access to the control panel. If the atany value is selected the parameters are denied: 'addr'
- addr - Allowed IP-addresses. (One or more values space-delimited)
- startpage - Start page.
- rows - Rows per page.
- recordlimit - Number of records .
- buttonview - Toolbar view.
Monitoring
Function: monitor
The function is simultaneously used to view and change form's data
View data:
- Result: parameters list
Change the data:
- Parameters:
- sok - the parameter must not be empty, generally "yes".
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
- schedule_minute - Минуты. The parameter may vary depending on feature svrmonitor.
- childproc - Количество процессов.
- timeout - Таймаут опроса сервера (сек).
Help
License
Function: softinfo
The function is simultaneously used to view and change form's data
View data:
- Result: parameters list
Change the data:
- Parameters:
- sok - the parameter must not be empty, generally "yes".
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
- os - OS version.
- mgrver - Current version.
- mgrbuild - Build date.
- licid - License ID.
- licip - License IP.
- licname - License name.
- licdate - Valid until .
Updates
Function: updatelist
Result: the list of elements
- id - The list element unique identifier
- version - Version.
- release - Release date.
- lines - Number of changes.
- backup - Backup date.
Function: updatelist.changelog
Parameters:
- elid - unique identifier ("id" element of "updatelist" function).
Result: elements list
- id - The list element unique identifier
- description - Description.
- isp1 - ISPmanager Lite.
- isp2 - ISPmanager Pro.
- isp3 - ISPmanager Cluster.
- bill1 - BILLmanager Standard.
- bill2 - BILLmanager Advanced.
- bill3 - BILLmanager Corparate.
- changetype - Type.
Function: updatelist.restore
The function is simultaneously used to view and change object's parameters.
View object's parameters:
- Parameters:
- elid - unique identifier ("id" element of "updatelist" function)
- Result: parameters list
Change an object:
- Parameters:
- sok - the parameter must not be empty, generally "yes".
- elid - unique identifier ("id" element of "updatelist" function)
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
Function: updatelist.settings
The function is simultaneously used to view and change form's data
View data:
- Result: parameters list
Change the data:
- Parameters:
- sok - the parameter must not be empty, generally "yes".
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
- os - Operating system.
- mgrver - Current version.
- mgrbuild - Compilation date.
- vertype - Version type.
- srvver - Latest version.
- mirror - Mirror.
- autoupdate - Automatic update. (Optional parameter. To enable the option click "on".)
Function: updatelist.updatenow
Wish list
Function: wishlist
Result: the list of elements
- id - ID .
- name - .
- created - Creation date .
- vote - Votes .
- jobeval - Labour intensity .
- prio - Priority .
- status - Status .
Function: wishlist.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 "wishlist" 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 "wishlist" function)
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
- name - Name .
- desc - Description .
- myvote - Available votes .
- vote - Add my vote.
Function: wishlist.vote
- myvote - Available votes .
- vote - Add my votes (for each feature) .
Function: wishlist.refresh
Error log
Function: errorjournal
Result: the list of elements
- date - Date .
- funcname - Function .
- lv_12 - .
- lv_11 - .
- lv_10 - .
- lv_7 - Administrator .
- lv_6 - Reseller .
- lv_5 - User .
- lv_4 - User with shell access .
- lv_3 - FTP account .
- lv_2 - Mailbox .
- user - User .
- status - Status .
Function: errorjournal.settings
The function is simultaneously used to view and change form's data
View data:
- Result: parameters list
Change the data:
- Parameters:
- sok - the parameter must not be empty, generally "yes".
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
- level - Logging level .
Function: errorjournal.edit
The function is simultaneously used to view and change object's parameters.
View object's parameters:
- Parameters:
- elid - unique identifier ("date" element of "errorjournal" function)
- Result: parameters list
Change an object:
- Parameters:
- sok - the parameter must not be empty, generally "yes".
- elid - unique identifier ("date" element of "errorjournal" function)
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
- email - Email .
- drop - Delete the report once it is sent . (Optional parameter. To enable the option click "on".)
- data - .
Function: errorjournal.delete
Parameters:
- elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "date" element of "errorjournal" function.
Result: successful operation or error message
- Use the "featurelist" API function to get the list of active features.
