Planfix API analitic.getGroupList

From Planfix
Revision as of 10:39, 4 March 2024 by Dmitri (talk | contribs) (Created page with "Запрос на получение списка групп аналитик имеет следующий вид: <source lang="xml"> <?xml version="1.0" encoding="UTF-8"?> <request method="analitic.getGroupList"> <account></account> <sid></sid> <signature></signature> </request> </source> {| class="wikitable" style="margin-top: 1em; width:100% " !width="150"|Name !!width="200"| Type !!width="50%"| Value !! Note |- |account|| string || the account on which...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

Запрос на получение списка групп аналитик имеет следующий вид:

<?xml version="1.0" encoding="UTF-8"?>
<request method="analitic.getGroupList">
    <account></account>
    <sid></sid>
    <signature></signature>
</request>
Name Type Value Note
account string the account on which the request is executed
sid string(32) session key issued as a result of passing authentication
signature string(32) package signature

The response, when the request is successfully executed:

<?xml version="1.0" encoding="UTF-8"?>
<response status="ok">
    <analiticGroups count="count" totalCount="totalCount">
        <group>
            <id></id>
            <name></name>
        </group>
        <group>
            <id></id>
            <name></name>
        </group>
        <!-- ... -->
    </analiticGroups>
</response>
Название Тип Значение Примечание
analiticGroups int list of groups
analiticGroups count int number of groups in the lis
analiticGroups totalCount int total number of groups in the list
group группа
group.id int group identifier
group.name string group name

Otherwise, a response with an error will be returned:

<?xml version="1.0" encoding="UTF-8"?>
<response status="error">
  <code></code>
</response>


Go To