ПланФикс API file.getGroupList: различия между версиями
Материал из Planfix
SliZzzZ (обсуждение | вклад) Нет описания правки |
SliZzzZ (обсуждение | вклад) |
||
Строка 65: | Строка 65: | ||
== Перейти == | == Перейти == | ||
*[[ПланФикс API:Работа с файлами]] | *[[ПланФикс API:Работа с файлами]] | ||
*[[Коды ошибок]] | |||
*[[Список функций]] | *[[Список функций]] |
Текущая версия от 13:00, 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>