X-Git-Url: https://git.stg.codes/stg.git/blobdiff_plain/2f8077c2f0f21056f5508ae7d05d62194edf5e40..bfec9cc7ab5a396f7662090b208691ec59a69f1b:/doc/xmlrpc-doc/API-user.xml?ds=sidebyside diff --git a/doc/xmlrpc-doc/API-user.xml b/doc/xmlrpc-doc/API-user.xml deleted file mode 100644 index fac4f2be..00000000 --- a/doc/xmlrpc-doc/API-user.xml +++ /dev/null @@ -1,1066 +0,0 @@ - - - Управление пользователями - - - stargazer.get_user - - - stargazer.get_user - Получение информации о пользователе - - - - - stargazer.get_user - string cookie - string login - - - - - Description - Метод stargazer.get_user возвращает информацию о пользователе системы. - - - string cookie - - Авторизационный cookie. Для авторизации в системе используется метод stargazer.login - - - - string login - - Логин пользователя - - - - - Return Value - - Возвращает структуру: - - - bool result - - Результат операции. true - успешно, false - неудача (неправильный или устаревший cookie, неправильный логин пользователя). - - - - string login - - Логин пользователя - - - - string password - - Пароль пользователя - - - - double cash - - Количество денег на счету - - - - double freemb - - Количество свободных мегабайт на счету - - - - double credit - - Размер кредита - - - - int creditexpire - - Время истечения срока кредита в формате Unix-timestamp - - - - string tariff - - Текущий тариф пользователя. В случае, если заказано изменение тарифа в следующем месяце возвращаются оба тарифа, разделенные символом "/" (косая черта) - - - - string note - - Примечания - - - - string phone - - Контактный телефон - - - - string address - - Адрес пользователя - - - - string email - - E-Mail пользователя - - - - array of strings userdata - - Набор полей UserData - - - - string name - - Реальное имя пользователя - - - - string group - - Группа пользователя - - - - boolean status - - Статус пользователя. true - подключен, false - отключен - - - - boolean aonline - - Признак "Always Online" - - - - boolean down - - Пользователь отключен - - - - boolean passive - - Пользователь "заморожен" - - - - boolean disableddetailstat - - Для пользователя отключено ведение детальной статистики - - - - string currip - - Текущий IP-адрес пользователя в формате A.B.C.D - - - - string ips - - IP-адреса, назначенные пользователю, разделенные символом "," (запятая) - - - - double lastcash - - Последнее пополнение счета - - - - double lasttimecash - - Время последнего пополнения счета в формате Unix-timestamp - - - - int lastactivitytime - - Время последней активности пользователя в формате Unix-timestamp - - - - int pingtime - - Время последнего пинга пользователя в формате Unix-timestamp - - - - struct traff - - Информация о трафике - - - array of i8 mu - - Исходяий трафик за месяц (по направлениям) - - - - array of i8 md - - Входящий трафик за месяц (по направлениям) - - - - array of i8 su - - Исходяий трафик за сессию (по направлениям) - - - - array of i8 sd - - Входящий трафик за сессию (по направлениям) - - - - - - - - - - - See also - - stargazer.get_users, - stargazer.add_user, - stargazer.chg_user, - stargazer.del_user, - stargazer.add_user_cash, - stargazer.set_user_cash, - stargazer.chg_user_tariff - stargazer.get_online_ips - - - - - - stargazer.get_users - - - stargazer.get_users - Получение информации о пользователях - - - - - stargazer.get_users - string cookie - - - - - Description - Метод stargazer.get_users возвращает информацию о пользователях системы. - - - string cookie - - Авторизационный cookie. Для авторизации в системе используется метод stargazer.login - - - - - Return Value - - Возвращает массив структур: - - - bool result - - Результат операции. true - успешно, false - неудача (неправильный или устаревший cookie, неправильный логин пользователя). - - - - string login - - Логин пользователя - - - - string password - - Пароль пользователя - - - - double cash - - Количество денег на счету - - - - double freemb - - Количество свободных мегабайт на счету - - - - double credit - - Размер кредита - - - - int creditexpire - - Время истечения срока кредита в формате Unix-timestamp - - - - string tariff - - Текущий тариф пользователя. В случае, если заказано изменение тарифа в следующем месяце возвращаются оба тарифа, разделенные символом "/" (косая черта) - - - - string note - - Примечания - - - - string phone - - Контактный телефон - - - - string address - - Адрес пользователя - - - - string email - - E-Mail пользователя - - - - array of strings userdata - - Набор полей UserData - - - - string name - - Реальное имя пользователя - - - - string group - - Группа пользователя - - - - boolean status - - Статус пользователя. true - подключен, false - отключен - - - - boolean aonline - - Признак "Always Online" - - - - boolean down - - Пользователь отключен - - - - boolean passive - - Пользователь "заморожен" - - - - boolean disableddetailstat - - Для пользователя отключено ведение детальной статистики - - - - string currip - - Текущий IP-адрес пользователя в формате A.B.C.D - - - - string ips - - IP-адреса, назначенные пользователю, разделенные символом "," (запятая) - - - - double lastcash - - Последнее пополнение счета - - - - double lasttimecash - - Время последнего пополнения счета в формате Unix-timestamp - - - - int lastactivitytime - - Время последней активности пользователя в формате Unix-timestamp - - - - int pingtime - - Время последнего пинга пользователя в формате Unix-timestamp - - - - struct traff - - Информация о трафике - - - array of i8 mu - - Исходяий трафик за месяц (по направлениям) - - - - array of i8 md - - Входящий трафик за месяц (по направлениям) - - - - array of i8 su - - Исходяий трафик за сессию (по направлениям) - - - - array of i8 sd - - Входящий трафик за сессию (по направлениям) - - - - - - - - - - - See also - - stargazer.get_user, - stargazer.add_user, - stargazer.chg_user, - stargazer.del_user, - stargazer.add_user_cash, - stargazer.set_user_cash, - stargazer.chg_user_tariff - stargazer.get_online_ips - - - - - - stargazer.add_user - - - stargazer.add_user - Регистрация нового пользователя - - - - - stargazer.add_user - string cookie - string login - - - - - Description - Метод stargazer.add_user регистрирует в системе нового "пустого" пользователя. Для изменения регистрационной информации сразу после создания используется метод stargazer.chg_user - - - string cookie - - Авторизационный cookie. Для авторизации в системе используется метод stargazer.login - - - - string login - - Логин пользователя - - - - - Return Value - Возвращает true в случае успеха и false в случае неудачи - - - - See also - - stargazer.get_users, - stargazer.get_user, - stargazer.chg_user, - stargazer.del_user, - stargazer.add_user_cash, - stargazer.set_user_cash, - stargazer.chg_user_tariff - stargazer.get_online_ips - - - - - - stargazer.chg_user - - - stargazer.chg_user - Изменение регистрационной информации и данных о трафике пользователя - - - - - stargazer.chg_user - string cookie - string login - struct info - - - - - Description - Метод stargazer.chg_user сохраняет регистрационную информацию и данные о трафике пользователя. Допустимо частичное указание параметров в структуре info. В этом случае изменение затронет только указанные параметры. Дополнительные поля структуры (не входящие в описание) будут проигнорированы. - - - string cookie - - Авторизационный cookie. Для авторизации в системе используется метод stargazer.login - - - - string login - - Логин пользователя - - - - struct info - - - Регистрационная информация и данные о трафике. - - - bool result - - Результат операции. true - успешно, false - неудача (неправильный или устаревший cookie, неправильный логин пользователя). - - - - string login - - Логин пользователя - - - - string password - - Пароль пользователя - - - - double freemb - - Количество свободных мегабайт на счету - - - - double credit - - Размер кредита - - - - int creditexpire - - Время истечения срока кредита в формате Unix-timestamp - - - - string note - - Примечания - - - - string phone - - Контактный телефон - - - - string address - - Адрес пользователя - - - - string email - - E-Mail пользователя - - - - array of strings userdata - - Набор полей UserData - - - - string name - - Реальное имя пользователя - - - - string group - - Группа пользователя - - - - boolean status - - Статус пользователя. true - подключен, false - отключен - - - - boolean aonline - - Признак "Always Online" - - - - boolean down - - Пользователь отключен - - - - boolean passive - - Пользователь "заморожен" - - - - boolean disableddetailstat - - Для пользователя отключено ведение детальной статистики - - - - string ips - - IP-адреса, назначенные пользователю, разделенные символом "," (запятая) - - - - struct traff - - Информация о трафике - - - array of i8 mu - - Исходяий трафик за месяц (по направлениям) - - - - array of i8 md - - Входящий трафик за месяц (по направлениям) - - - - - - - - - - - - Return Value - Возвращает true в случае успеха и false в случае неудачи - - - - See also - - stargazer.get_users, - stargazer.get_user, - stargazer.add_user, - stargazer.del_user, - stargazer.add_user_cash, - stargazer.set_user_cash, - stargazer.chg_user_tariff - stargazer.get_online_ips - - - - - - stargazer.del_user - - - stargazer.del_user - Удаление пользователя - - - - - stargazer.del_user - string cookie - string login - - - - - Description - Метод stargazer.del_user удаляет из системы пользователя с указанным логином. - - - string cookie - - Авторизационный cookie. Для авторизации в системе используется метод stargazer.login - - - - string login - - Логин пользователя - - - - - Return Value - Возвращает true в случае успеха и false в случае неудачи - - - - See also - - stargazer.get_users, - stargazer.get_user, - stargazer.add_user, - stargazer.chg_user, - stargazer.add_user_cash, - stargazer.set_user_cash, - stargazer.chg_user_tariff - stargazer.get_online_ips - - - - - - stargazer.add_user_cash - - - stargazer.add_user_cash - Добавление денег на счет пользователя - - - - - stargazer.add_user_cash - string cookie - string login - double amount - string comment - - - - - Description - Метод stargazer.add_user_cash позволяет добавить деньги на счет указанного пользователя. - - - string cookie - - Авторизационный cookie. Для авторизации в системе используется метод stargazer.login - - - - string login - - Логин пользователя - - - - double amount - - Добавляемая сумма - - - - string comment - - Коментарий - - - - - Return Value - Возвращает true в случае успеха и false в случае неудачи - - - - See also - - stargazer.get_users, - stargazer.get_user, - stargazer.add_user, - stargazer.chg_user, - stargazer.del_user, - stargazer.set_user_cash, - stargazer.chg_user_tariff - stargazer.get_online_ips - - - - - - stargazer.set_user_cash - - - stargazer.set_user_cash - Установка состояния счета пользователя - - - - - stargazer.set_user_cash - string cookie - string login - double cash - string comment - - - - - Description - Метод stargazer.set_user_cash позволяет установить состояние счета пользователя. - - - string cookie - - Авторизационный cookie. Для авторизации в системе используется метод stargazer.login - - - - string login - - Логин пользователя - - - - double cash - - Устанавливаемая сумма - - - - string comment - - Коментарий - - - - - Return Value - Возвращает true в случае успеха и false в случае неудачи - - - - See also - - stargazer.get_users, - stargazer.get_user, - stargazer.add_user, - stargazer.chg_user, - stargazer.del_user, - stargazer.add_user_cash, - stargazer.chg_user_tariff - stargazer.get_online_ips - - - - - - stargazer.chg_user_tariff - - - stargazer.chg_user_tariff - Изменение тарифного плана пользователя - - - - - stargazer.chg_user_tariff - string cookie - string login - string tariff - boolean delayed - string comment - - - - - Description - Метод stargazer.chg_user_tariff позволяет изменить тарифный план пользователя или запланировать его изменение на начало нового месяца. - - - string cookie - - Авторизационный cookie. Для авторизации в системе используется метод stargazer.login - - - - string login - - Логин пользователя - - - - string tariff - - Название нового тарифа - - - - boolean delayed - - Отложенное изменение тарифа (в начале следующего месяца) - - - - string comment - - Коментарий - - - - - Return Value - Возвращает true в случае успеха и false в случае неудачи - - - - See also - - stargazer.get_users, - stargazer.get_user, - stargazer.add_user, - stargazer.chg_user, - stargazer.del_user, - stargazer.add_user_cash, - stargazer.set_user_cash - stargazer.get_online_ips - - - - - - stargazer.get_online_ips - - - stargazer.get_online_ips - Получение списка IP-адресов online-пользователей - - - - - stargazer.get_online_ips - string cookie - array of strings subnets - - - - - Description - Метод stargazer.get_online_ips позволяет получить список IP-адресов авторизованных пользователей системы для указанного списка подсетей. - - - string cookie - - Авторизационный cookie. Для авторизации в системе используется метод stargazer.login - - - - array of strings subnets - - Список подсетей в CIDR-нотации - - - - - Return Value - Возвращает структуру: - - - bool result - - Результат операции. true - успешно, false - неудача (неправильный или устаревший cookie). - - - - array of strings ips - - Список IP-адресов авторизованных пользователей из этих подсетей - - - - - - - See also - - stargazer.get_users, - stargazer.get_user, - stargazer.add_user, - stargazer.chg_user, - stargazer.del_user, - stargazer.add_user_cash, - stargazer.set_user_cash - stargazer.chg_user_tariff - - - -