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

Версия 08:16, 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>
</request>

Все параметры, за исключением account, sid, не являются обязательными. Если опустить параметр login, то будет получен список проектов доступных для текущего пользователя, необходимо помнить что только администраторы могут смотреть проекты других участников. Допустимые значения для target, status, sortType.

Ответ, пустой ответ не генерирует ошибку:

<?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	неизвестная ошибка

Перейти