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

Материал из ПланФикс
Перейти к: навигация, поиск
(Новая страница: «Функция позволяет получить информацию о проекте. Формат запроса: <source lang="xml"> <?xml version="1.0" encod...»)
 
Строка 41: Строка 41:
 
     <endDate></endDate>
 
     <endDate></endDate>
 
     <beginDate></beginDate>
 
     <beginDate></beginDate>
 +
    <taskCount></taskCount>
 
     <isOverdued></isOverdued>
 
     <isOverdued></isOverdued>
−
<!-- осталось 25% времени до завершения или прошло 75% отведенного времени на выполнение его -->
+
     <isCloseToDeadline></isCloseToDeadline>
−
     <isCloseToDeadline>{true|false}</isCloseToDeadline>
 
 
   </project>
 
   </project>
 
</response>
 
</response>
Строка 50: Строка 50:
 
!width="150"|Название !!width="200"| Тип !!width="50%"| Значение !! Примечание  
 
!width="150"|Название !!width="200"| Тип !!width="50%"| Значение !! Примечание  
 
|-
 
|-
−
|id || || ||
+
|id || int ||идентификатор проекта ||
 
|-
 
|-
−
| || || ||
+
|title || string || название проекта ||
 
|-
 
|-
−
| || || ||
+
|description || string || описание проекта ||
 
|-
 
|-
−
| || || ||
+
|owner || || создатель/владелец проекта ||
 
|-
 
|-
−
| || || ||
+
|owner.id || int|| идентификатор пользователя создавшего пользователя||
 
|-
 
|-
−
| || || ||
+
|owner.name ||string ||имя пользователя создавшего проект ||
 
|-
 
|-
−
| || || ||
+
|client || || контрагент||
 
|-
 
|-
−
| || || ||
+
|client.id ||int ||идентификатор контрагента ||
 
|-
 
|-
−
| || || ||
+
|client.name ||int ||имя контрагента ||
 
|-
 
|-
−
| || || ||
+
|status || enum||статус проекта || перечень допустимых значений для данного поля смотри в разделе [[ПланФикс API:Статусы проектов|статусы проектов]]
 
|-
 
|-
−
| || || ||
+
|hidden || bool|| скрытый ли проект || отображается ли он в общем списке
 
|-
 
|-
−
| || || ||
+
|hasEndDate || bool|| true/false - имеет ли проект дату завершения ||  
 
|-
 
|-
−
| || || ||
+
|endDate ||DateTime || дата завершения проекта || имеет значение только если установлен флаг '''hasEndDate'''
 
|-
 
|-
−
| || || ||
+
|beginDate ||DateTime ||дата создания проекта ||
 
|-
 
|-
−
| || || ||
+
|taskCount ||int ||количество задач в проекте ||
 
|-
 
|-
−
| || || ||
+
|isOverdued ||bool ||true/false - является ли проект просроченным ||
 +
|-
 +
|isCloseToDeadline ||bool || true/false  ||осталось 25% времени до завершения или прошло 75% отведенного времени на выполнение его
 
|-
 
|-
 
|}
 
|}
  
−
В противном случае будет возвращен ответ с ошибкой.
+
В противном случае будет возвращен ответ с ошибкой:
 +
<source lang="xml">
 +
<?xml version="1.0" encoding="UTF-8"?>
 +
<response status="error">
 +
  <code></code>
 +
</response>
 +
</source>
 +
{| class="wikitable" style="margin-top: 1em; width:100% "
 +
!width="50"|Значение ''code'' !! Расшифровка
 +
|-
 +
|0000|| неизвестная ошибка
 +
|-
 +
|}

Версия 07:58, 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 неизвестная ошибка
Источник — «http://planfix.ru/wiki/index.php?title=ПланФикс_API_project.get&oldid=249»