ПланФикс API file.getGroupList: различия между версиями

Версия от 12:39, 27 октября 2010

Функция позволяет получить список групп файлов. Формат запроса:

<?xml version="1.0" encoding="UTF-8"?>
<request method="file.getGroupList">
  <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">
  <fileGroups count="count" totalCount="totalCount">
    <fileGroup>
      <id></id>
      <name></name>
    </fileGroup>
    <fileGroup>
      <!-- ... -->
    </fileGroup>
    <!-- ... -->
  </fileGroups>
</response>

Название	Тип	Значение	Примечание
fileGroups		корневой элемент списка групп файлов
fileGroups count		количество элементов в списке
fileGroups totalCount		также равно количеству элементов в списке
fileGroup		узел описывающий элемент группы файла
fileGroup.id		идентификатор записи
fileGroup.name		название группы

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

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

Перейти

@@ Строка 60: / Строка 60: @@
 </response>
 </source>
-{| class="wikitable" style="margin-top: 1em; width:100% "
-!width="50"|Значение ''code'' !! Расшифровка
-|-
-|align="center"| 0000|| неизвестная ошибка
-|-
-|}