+++ /dev/null
-<?xml version='1.0' encoding='UTF-8'?>
-<chapter xmlns="http://docbook.org/ns/docbook">
- <title>Управление админами</title>
- <para>В этом разделе собраны вызовы API для управления с администраторами системы: удаление, добавление, изменение прав и т.д.</para>
- <refentry id="stargazer.get_admin">
- <refmeta>
- <refentrytitle>stargazer.get_admin</refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>stargazer.get_admin</refname>
- <refpurpose>Получает информацию об администраторе системы</refpurpose>
- </refnamediv>
- <refsynopsisdiv>
- <funcsynopsis>
- <funcprototype>
- <funcdef><function>stargazer.get_admin</function></funcdef>
- <paramdef>string <parameter>cookie</parameter></paramdef>
- <paramdef>string <parameter>login</parameter></paramdef>
- </funcprototype>
- </funcsynopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>Метод <function>stargazer.get_admin</function> получает информацию об администраторе системы.</para>
- <variablelist>
- <varlistentry>
- <term>string <parameter>cookie</parameter></term>
- <listitem>
- <para>Авторизационный cookie. Для авторизации в системе используется метод <function><link linkend="stargazer.login">stargazer.login</link></function></para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>string <parameter>login</parameter></term>
- <listitem>
- <para>Логин администратора</para>
- </listitem>
- </varlistentry>
- </variablelist>
- <refsect2>
- <title>Return Value</title>
- <para>
- Возвращает структуру:
- <variablelist>
- <varlistentry>
- <term>boolean <parameter>result</parameter></term>
- <listitem>
- <para>Результат операции. true - успешно, false - неудача (неправильный или устаревший cookie, неправильное название тарифа).</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>string <parameter>login</parameter></term>
- <listitem>
- <para>Логин администратора</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>boolean <parameter>user_stat</parameter></term>
- <listitem>
- <para>Право на изменение статистики пользователя (включая состояние счета)</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>boolean <parameter>user_conf</parameter></term>
- <listitem>
- <para>Право на изменение конфигурации пользователя (включая пароль)</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>boolean <parameter>user_cash</parameter></term>
- <listitem>
- <para>Право на изменение состояния счета пользователя</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>boolean <parameter>user_passwd</parameter></term>
- <listitem>
- <para>Право на изменение пароля пользователя</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>boolean <parameter>user_add_del</parameter></term>
- <listitem>
- <para>Право на добавление и удаление пользователей</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>boolean <parameter>admin_chg</parameter></term>
- <listitem>
- <para>Право на управление администраторами</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>boolean <parameter>tariff_chg</parameter></term>
- <listitem>
- <para>Право на управление тарифами</para>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
- </refsect2>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para>
- <link linkend="stargazer.get_admins"><function>stargazer.get_admins</function></link>,
- <link linkend="stargazer.add_admin"><function>stargazer.add_admin</function></link>,
- <link linkend="stargazer.del_admin"><function>stargazer.del_admin</function></link>,
- <link linkend="stargazer.chg_admin"><function>stargazer.chg_admin</function></link>
- </para>
- </refsect1>
- </refentry>
- <refentry id="stargazer.get_admins">
- <refmeta>
- <refentrytitle>stargazer.get_admins</refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>stargazer.get_admins</refname>
- <refpurpose>Получает информацию об админах</refpurpose>
- </refnamediv>
- <refsynopsisdiv>
- <funcsynopsis>
- <funcprototype>
- <funcdef><function>stargazer.get_admins</function></funcdef>
- <paramdef>string <parameter>cookie</parameter></paramdef>
- </funcprototype>
- </funcsynopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>Метод <function>stargazer.get_admins</function> получает информацию об админах, зарегистрированных в системе.</para>
- <variablelist>
- <varlistentry>
- <term>string <parameter>cookie</parameter></term>
- <listitem>
- <para>Авторизационный cookie. Для авторизации в системе используется метод <function><link linkend="stargazer.login">stargazer.login</link></function></para>
- </listitem>
- </varlistentry>
- </variablelist>
- <refsect2>
- <title>Return Value</title>
- <para>
- Возвращает массив структур:
- <variablelist>
- <varlistentry>
- <term>boolean <parameter>result</parameter></term>
- <listitem>
- <para>Результат операции. true - успешно, false - неудача (неправильный или устаревший cookie, неправильное название тарифа).</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>string <parameter>login</parameter></term>
- <listitem>
- <para>Логин администратора</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>boolean <parameter>user_stat</parameter></term>
- <listitem>
- <para>Право на изменение статистики пользователя (включая состояние счета)</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>boolean <parameter>user_conf</parameter></term>
- <listitem>
- <para>Право на изменение конфигурации пользователя (включая пароль)</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>boolean <parameter>user_cash</parameter></term>
- <listitem>
- <para>Право на изменение состояния счета пользователя</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>boolean <parameter>user_passwd</parameter></term>
- <listitem>
- <para>Право на изменение пароля пользователя</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>boolean <parameter>user_add_del</parameter></term>
- <listitem>
- <para>Право на добавление и удаление пользователей</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>boolean <parameter>admin_chg</parameter></term>
- <listitem>
- <para>Право на управление администраторами</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>boolean <parameter>tariff_chg</parameter></term>
- <listitem>
- <para>Право на управление тарифами</para>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
- </refsect2>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para>
- <link linkend="stargazer.get_admin"><function>stargazer.get_admin</function></link>,
- <link linkend="stargazer.add_admin"><function>stargazer.add_admin</function></link>,
- <link linkend="stargazer.del_admin"><function>stargazer.del_admin</function></link>,
- <link linkend="stargazer.chg_admin"><function>stargazer.chg_admin</function></link>
- </para>
- </refsect1>
- </refentry>
- <refentry id="stargazer.del_admin">
- <refmeta>
- <refentrytitle>stargazer.del_admin</refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>stargazer.del_admin</refname>
- <refpurpose>Удаляет администратора из системы</refpurpose>
- </refnamediv>
- <refsynopsisdiv>
- <funcsynopsis>
- <funcprototype>
- <funcdef><function>stargazer.del_admin</function></funcdef>
- <paramdef>string <parameter>cookie</parameter></paramdef>
- <paramdef>string <parameter>login</parameter></paramdef>
- </funcprototype>
- </funcsynopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>Метод <function>stargazer.del_admin</function> удаляет администратора из системы.</para>
- <variablelist>
- <varlistentry>
- <term>string <parameter>cookie</parameter></term>
- <listitem>
- <para>Авторизационный cookie. Для авторизации в системе используется метод <function><link linkend="stargazer.login">stargazer.login</link></function></para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>string <parameter>login</parameter></term>
- <listitem>
- <para>Логин удаляемого администратора</para>
- </listitem>
- </varlistentry>
- </variablelist>
- <refsect2>
- <title>Return Value</title>
- <para>Возвращает true в случае успеха и false в случае неудачи</para>
- </refsect2>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para>
- <link linkend="stargazer.get_admins"><function>stargazer.get_admins</function></link>,
- <link linkend="stargazer.get_admin"><function>stargazer.get_admin</function></link>,
- <link linkend="stargazer.add_admin"><function>stargazer.add_admin</function></link>,
- <link linkend="stargazer.chg_admin"><function>stargazer.chg_admin</function></link>
- </para>
- </refsect1>
- </refentry>
- <refentry id="stargazer.add_admin">
- <refmeta>
- <refentrytitle>stargazer.add_admin</refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>stargazer.add_admin</refname>
- <refpurpose>Добавляет администратора в систему</refpurpose>
- </refnamediv>
- <refsynopsisdiv>
- <funcsynopsis>
- <funcprototype>
- <funcdef><function>stargazer.add_admin</function></funcdef>
- <paramdef>string <parameter>cookie</parameter></paramdef>
- <paramdef>string <parameter>login</parameter></paramdef>
- </funcprototype>
- </funcsynopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>Метод <function>stargazer.add_admin</function> добавляет администратора в систему.</para>
- <variablelist>
- <varlistentry>
- <term>string <parameter>cookie</parameter></term>
- <listitem>
- <para>Авторизационный cookie. Для авторизации в системе используется метод <function><link linkend="stargazer.login">stargazer.login</link></function></para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>string <parameter>login</parameter></term>
- <listitem>
- <para>Логин добавляемого администратора</para>
- </listitem>
- </varlistentry>
- </variablelist>
- <refsect2>
- <title>Return Value</title>
- <para>Возвращает true в случае успеха и false в случае неудачи</para>
- </refsect2>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para>
- <link linkend="stargazer.get_admins"><function>stargazer.get_admins</function></link>,
- <link linkend="stargazer.get_admin"><function>stargazer.get_admin</function></link>,
- <link linkend="stargazer.del_admin"><function>stargazer.del_admin</function></link>,
- <link linkend="stargazer.chg_admin"><function>stargazer.chg_admin</function></link>
- </para>
- </refsect1>
- </refentry>
- <refentry id="stargazer.chg_admin">
- <refmeta>
- <refentrytitle>stargazer.chg_admin</refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>stargazer.chg_admin</refname>
- <refpurpose>Изменяет права и/или пароль администратора</refpurpose>
- </refnamediv>
- <refsynopsisdiv>
- <funcsynopsis>
- <funcprototype>
- <funcdef><function>stargazer.chg_admin</function></funcdef>
- <paramdef>string <parameter>cookie</parameter></paramdef>
- <paramdef>string <parameter>login</parameter></paramdef>
- <paramdef>struct <parameter>info</parameter></paramdef>
- </funcprototype>
- </funcsynopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>Метод <function>stargazer.chg_admin</function> изменяет права и/или пароль администратора системы. Допустимо частичное указание параметров в структуре info. В этом случае изменение затронет только указанные параметры. Дополнительные поля структуры (не входящие в описание) будут проигнорированы.</para>
- <variablelist>
- <varlistentry>
- <term>string <parameter>cookie</parameter></term>
- <listitem>
- <para>Авторизационный cookie. Для авторизации в системе используется метод <function><link linkend="stargazer.login">stargazer.login</link></function></para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>string <parameter>login</parameter></term>
- <listitem>
- <para>Логин изменяемого администратора</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>struct <parameter>info</parameter></term>
- <listitem>
- <para>
- Структура с информацией об админе:
- <variablelist>
- <varlistentry>
- <term>string <parameter>login</parameter></term>
- <listitem>
- <para>Логин администратора</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>boolean <parameter>user_stat</parameter></term>
- <listitem>
- <para>Право на изменение статистики пользователя (включая состояние счета)</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>boolean <parameter>user_conf</parameter></term>
- <listitem>
- <para>Право на изменение конфигурации пользователя (включая пароль)</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>boolean <parameter>user_cash</parameter></term>
- <listitem>
- <para>Право на изменение состояния счета пользователя</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>boolean <parameter>user_passwd</parameter></term>
- <listitem>
- <para>Право на изменение пароля пользователя</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>boolean <parameter>user_add_del</parameter></term>
- <listitem>
- <para>Право на добавление и удаление пользователей</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>boolean <parameter>admin_chg</parameter></term>
- <listitem>
- <para>Право на управление администраторами</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>boolean <parameter>tariff_chg</parameter></term>
- <listitem>
- <para>Право на управление тарифами</para>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- <refsect2>
- <title>Return Value</title>
- <para>Возвращает true в случае успеха и false в случае неудачи</para>
- </refsect2>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para>
- <link linkend="stargazer.get_admins"><function>stargazer.get_admins</function></link>,
- <link linkend="stargazer.get_admin"><function>stargazer.get_admin</function></link>,
- <link linkend="stargazer.del_admin"><function>stargazer.del_admin</function></link>,
- <link linkend="stargazer.add_admin"><function>stargazer.add_admin</function></link>
- </para>
- </refsect1>
- </refentry>
-</chapter>
git.stg.codes / stg.git / blobdiff