ПланФикс API project.getList — различия между версиями
Материал из ПланФикс
Seva (обсуждение | вклад) |
Seva (обсуждение | вклад) |
||
| Строка 26: | Строка 26: | ||
|user.id ||int ||идентификатор пользователя || | |user.id ||int ||идентификатор пользователя || | ||
|- | |- | ||
| − | |target || enum ||фильтр по вкладкам ||не обязательный параметр | + | |target || enum ||фильтр по вкладкам ||не обязательный параметр. список допустимых значений смотри в разделе [[ПланФикс API:Фильтр вкладки для проектов|фильтр вкладки для проектов]] |
|- | |- | ||
| − | |status || enum ||фильтр по статусу ||не обязательный параметр | + | |status || enum ||фильтр по статусу ||не обязательный параметр. перечень допустимых значений для данного поля смотри в разделе [[ПланФикс API:Статусы проектов|статусы проектов]] |
|- | |- | ||
| − | |sortType ||enum ||тип сортировки ||не обязательный параметр | + | |sortType ||enum ||тип сортировки ||не обязательный параметр. список допустимых значений смотри в разделе [[ПланФикс API:Типы сортировок для проектов|типы сортировок для проектов]] |
|- | |- | ||
|pageCurrent || int|| постраничная навигация ||не обязательный параметр | |pageCurrent || int|| постраничная навигация ||не обязательный параметр | ||
| Строка 38: | Строка 38: | ||
|client || || ||не обязательный параметр | |client || || ||не обязательный параметр | ||
|- | |- | ||
| − | |client.id ||int || || | + | |client.id ||int || идентификатор контрагента, выступает в качестве фильтра || |
|- | |- | ||
| − | |signature ||string(32) || || | + | |signature ||string(32) || подпись || |
|- | |- | ||
|} | |} | ||
| − | Все параметры, за исключением '''account''', '''sid''', не являются обязательными. Если опустить параметр ''' | + | Все параметры, за исключением '''account''', '''sid''', '''signature ''' не являются обязательными. Если опустить параметр '''user''', то будет получен список проектов доступных для текущего пользователя, необходимо помнить что только администраторы могут смотреть проекты других участников. |
| − | Ответ | + | Ответ: |
<source lang="xml"> | <source lang="xml"> | ||
<?xml version="1.0" encoding="UTF-8"?> | <?xml version="1.0" encoding="UTF-8"?> | ||
| Строка 75: | Строка 75: | ||
</response> | </response> | ||
</source> | </source> | ||
| − | Если в результирующую выборку не попадают никакие проекты, то ответ будет иметь следующую форму? | + | Пустой ответ не '''генерирует ошибку'''. Если в результирующую выборку не попадают никакие проекты, то ответ будет иметь следующую форму? |
<source lang="xml"> | <source lang="xml"> | ||
<?xml version="1.0" encoding="UTF-8"?> | <?xml version="1.0" encoding="UTF-8"?> | ||
Версия 11:37, 20 августа 2010
Функция для получения списка проектов. Формат запроса:
<?xml version="1.0" encoding="UTF-8"?>
<request method="project.getList">
<account></account>
<sid></sid>
<user>
<id></id>
</user>
<target></target>
<status></status>
<sortType></sortType>
<pageCurrent></pageCurrent>
<pageSize></pageSize>
<client>
<id></id>
</client>
<signature></signature>
</request>| Название | Тип | Значение | Примечание |
|---|---|---|---|
| user | пользователь ПланФикса | не обязательный параметр. задается для того чтоб посмотреть проекты в которых принимает участие указанный пользователь. этот параметр должен задаваться только в том случае, если выполняется запрос от учетной записи с админ правами | |
| user.id | int | идентификатор пользователя | |
| target | enum | фильтр по вкладкам | не обязательный параметр. список допустимых значений смотри в разделе фильтр вкладки для проектов |
| status | enum | фильтр по статусу | не обязательный параметр. перечень допустимых значений для данного поля смотри в разделе статусы проектов |
| sortType | enum | тип сортировки | не обязательный параметр. список допустимых значений смотри в разделе типы сортировок для проектов |
| pageCurrent | int | постраничная навигация | не обязательный параметр |
| pageSize | int | не обязательный параметр | |
| client | не обязательный параметр | ||
| client.id | int | идентификатор контрагента, выступает в качестве фильтра | |
| signature | string(32) | подпись |
Все параметры, за исключением account, sid, signature не являются обязательными. Если опустить параметр user, то будет получен список проектов доступных для текущего пользователя, необходимо помнить что только администраторы могут смотреть проекты других участников.
Ответ:
<?xml version="1.0" encoding="UTF-8"?>
<response status="ok">
<prejects count="count" totalCount="totalCount">
<project>
<id></id>
<title></title>
<description></description>
<owner>
<id></id>
<name></name>
</owner>
<client>
<id></id>
<name></name>
</client>
<status></status>
<hidden></hidden>
<HasEndDate></HasEndDate>
<EndDate></EndDate>
<BeginDate></BeginDate>
<taskCount></taskCount>
<IsOverdued></IsOverdued>
<IsCloseToDeadline></IsCloseToDeadline>
</project>
<!-- ... -->
</prejects>
</response>Пустой ответ не генерирует ошибку. Если в результирующую выборку не попадают никакие проекты, то ответ будет иметь следующую форму?
<?xml version="1.0" encoding="UTF-8"?>
<response status="ok">
<prejects count="0" totalCount="0"></prejects>
</response>В противном случае будет возвращен ответ с ошибкой:
<?xml version="1.0" encoding="UTF-8"?>
<response status="error">
<code></code>
</response>| Значение code | Расшифровка |
|---|---|
| 0000 | неизвестная ошибка |