ПланФикс API user.getList: различия между версиями
Материал из Planfix
SliZzzZ (обсуждение | вклад) Нет описания правки |
SliZzzZ (обсуждение | вклад) |
||
Строка 73: | Строка 73: | ||
== Перейти == | == Перейти == | ||
*[[ПланФикс API:Сотрудники]] | *[[ПланФикс API:Сотрудники]] | ||
*[[Коды ошибок]] | |||
*[[Список функций]] | *[[Список функций]] |
Версия от 12:55, 27 октября 2010
Функция получения списка пользователей. Формат запроса:
<?xml version="1.0" encoding="UTF-8"?>
<request method="user.getList">
<account></account>
<sid></sid>
<status></status>
<userGroup>
<id></id>
</userGroup>
<sortType></sortType>
<pageCurrent></pageCurrent>
<pageSize></pageSize>
<signature></signature>
</request>
Название | Тип | Значение | Примечание |
---|---|---|---|
status | enum | статус пользователя | список допустимых значений смотри в разделе статусы пользователей |
userGroup.id | int | идентификатор группы (фильтр по группе) | |
sortType | enum | тип сортировки | список допустимых значений смотри в разделе типы сортировок пользователей |
pageCurrent | int | текущая страница | |
pageSize | int | размер получаемого списка | не больше 50 |
signature | string(32) | подпись |
Ответ:
<response status="ok">
<users count="count" totalCount="totalCount">
<user>
<!-- ... -->
</user>
<user>
<!-- ... -->
</user>
<!-- ... -->
</users>
</response>
Название | Тип | Значение | Примечание |
---|---|---|---|
users | список пользователей | ||
users count | int | количество пользователей в списке | |
users totalCount | int | количество пользователей удовлетворяющих условию запроса | |
users.user | описание пользователя, смотри полное описание структуры в разделе user.get |
В противном случае будет возвращен ответ с ошибкой:
<?xml version="1.0" encoding="UTF-8"?>
<response status="error">
<code></code>
</response>