ПланФикс API analitic.getList — различия между версиями

Текущая версия на 12:08, 2 сентября 2021

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

<?xml version="1.0" encoding="UTF-8"?>
<request method="analitic.getList">
    <account></account>
    <sid></sid>
    <signature></signature>
</request>

Название	Тип	Значение	Примечание
account	string	аккаунт, на котором выполняется запрос
sid	string(32)	ключ сесии	выдается в результате прохождения аутентификации
signature	string(32)	подпись пакета

Ответ, при успешном выполнении запроса:

<?xml version="1.0" encoding="UTF-8"?>
<response status="ok">
    <analitics  count="count" totalCount="totalCount">
        <analitic>
            <id></id>
            <name></name>
            <group>
                <id></id>
                <name></name>
            </group>
        </analitic>
        <analitic>
            <id></id>
            <name></name>
            <group>
                <id></id>
                <name></name>
            </group>
        </analitic>
        <!-- ... -->
    </analitics>
</response>

Название	Тип	Значение
analitics	int	список аналитик
analitics count	int	количество аналитик в списке
analitics totalCount	int	количество аналитик в списке
analitic		аналитика
analitic.id	int	идентификатор аналитики
analitic.name	string	название аналитики
analitic.group		группа
analitic.group.id	int	идентификатор группы
analitic.group.name	string	название группы

В противном случае будет возвращен ответ с ошибкой:

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

Перейти

@@ Строка 2: / Строка 2: @@
 <source lang="xml">
 <?xml version="1.0" encoding="UTF-8"?>
-<request method="analitic.getGroupList">
+<request method="analitic.getList">
      <account></account>
      <sid></sid>
-    <analiticGroup>
-      <id></id>
-    </analiticGroup>
      <signature></signature>
 </request>
@@ Строка 17: / Строка 14: @@
 |-
 |sid || string(32) ||ключ сесии || выдается в результате прохождения [[ПланФикс API:Аутентификация|аутентификации]]
-|-
-|analiticGroup.id || int || идентификатор группы || необязательный параметр
 |-
 |signature|| string(32) || подпись пакета ||