ПланФикс API project.get — различия между версиями
Материал из ПланФикс
								
												
				Seva (обсуждение | вклад)  | 
				Seva (обсуждение | вклад)  м  | 
				||
| Строка 96: | Строка 96: | ||
!width="50"|Значение ''code'' !! Расшифровка  | !width="50"|Значение ''code'' !! Расшифровка  | ||
|-  | |-  | ||
| − | |0000|| неизвестная ошибка  | + | |align="center"| 0000|| неизвестная ошибка  | 
|-  | |-  | ||
|}  | |}  | ||
Версия 07:59, 20 августа 2010
Функция позволяет получить информацию о проекте. Формат запроса:
<?xml version="1.0" encoding="UTF-8"?>
<request method="project.get">
  <account></account>
  <sid></sid>
  <project>
    <id></id>
  </project>
  <signature></signature>
</request>| Название | Тип | Значение | Примечание | 
|---|---|---|---|
| project.id | int | идентификатор запрашиваемого проекта | |
| signature | string(32) | подпись | 
Ответ:
<?xml version="1.0" encoding="UTF-8"?>
<response status="ok">
  <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>
</response>| Название | Тип | Значение | Примечание | 
|---|---|---|---|
| id | int | идентификатор проекта | |
| title | string | название проекта | |
| description | string | описание проекта | |
| owner | создатель/владелец проекта | ||
| owner.id | int | идентификатор пользователя создавшего пользователя | |
| owner.name | string | имя пользователя создавшего проект | |
| client | контрагент | ||
| client.id | int | идентификатор контрагента | |
| client.name | int | имя контрагента | |
| status | enum | статус проекта | перечень допустимых значений для данного поля смотри в разделе статусы проектов | 
| hidden | bool | скрытый ли проект | отображается ли он в общем списке | 
| hasEndDate | bool | true/false - имеет ли проект дату завершения | |
| endDate | DateTime | дата завершения проекта | имеет значение только если установлен флаг hasEndDate | 
| beginDate | DateTime | дата создания проекта | |
| taskCount | int | количество задач в проекте | |
| isOverdued | bool | true/false - является ли проект просроченным | |
| isCloseToDeadline | bool | true/false | осталось 25% времени до завершения или прошло 75% отведенного времени на выполнение его | 
В противном случае будет возвращен ответ с ошибкой:
<?xml version="1.0" encoding="UTF-8"?>
<response status="error">
  <code></code>
</response>| Значение code | Расшифровка | 
|---|---|
| 0000 | неизвестная ошибка | 
