Planfix API: project.get

A function that gets information about a project. Request format:

<?xml version="1.0" encoding="UTF-8"?>
<request method="project.get">
  <account></account>
  <sid></sid>
  <project>
    <id></id>
    <general></general>
  </project>
  <signature></signature>
</request>

Name	Type	Value	Notes
project.id	int	identifier of the given project
project.general	int	project number	used when there is no ID parameter id
signature	string(32)	signature

Response:

<?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>
    <group>
      <id></id>
      <name></name>
    </group>
    <parent>
      <id></id>
    </parent>
    <template>
      <id></id>
    </template>
    <status></status>
    <hidden></hidden>
    <hasEndDate></hasEndDate>
    <endDate></endDate>
    <beginDate></beginDate>
    <taskCount></taskCount>
    <isOverdued></isOverdued>
    <isCloseToDeadline></isCloseToDeadline>

    <workers>
      <users>
        <user>
          <id></id>
          <name></name>
        </user>
        <!-- ... -->
      </users>
      <groups>
        <group>
          <id></id>
          <name></name>
        </group>
        <!-- ... -->
      </groups>
    </workers>
    <members>
      <users>
        <user>
          <id></id>
          <name></name>
        </user>
        <!-- ... -->
      </users>
      <groups>
        <group>
          <id></id>
          <name></name>
        </group>
        <!-- ... -->
      </groups>
    </members>
    <auditors>
      <users>
        <user>
          <id></id>
          <name></name>
        </user>
        <!-- ... -->
      </users>
    </auditors>
    <customData>
      <customValue>
        <field>
          <id></id>
          <name></name>
        </field>
        <value></value>
        <text></text>
      </customValue>
      <customValue>
        <!-- ... -->
      </customValue>
      <!-- ... -->
    </customData>
  </project>
</response>

Name	Type	Value	Notes
id	int	project identifier
title	string	project name
description	string	project description
owner		project creator/owner
owner.id	int	identifier of the user who created the project
owner.name	string	name of the user who created the project
client		counterparty
client.id	int	counterparty identifier
client.name	string	counterparty name
group		project group
group.id	int	project group identifier
group.name	string	project group name
parent		parent project
parent.id	int	parent project identifier
template		template
template.id	int	template identifier
status	enum	project status	for a list of valid values for this field, see the project statuses section Project statuses
hidden	bool	скрытый ли проект	отображается ли он в общем списке
hasEndDate	bool	true/false - имеет ли проект дату завершения
endDate	DateTime	дата завершения проекта	имеет значение только если установлен флаг hasEndDate
beginDate	DateTime	дата создания проекта
taskCount	int	количество задач в проекте
isOverdued	bool	true/false - является ли проект просроченным
isCloseToDeadline	bool	true/false	осталось 25% времени до завершения или прошло 75% отведенного времени на выполнение его
workers		корневой элемент списка исполнителей по умолчанию проекта
workers.users		корневой элемент списка пользователей из числа исполнителей по умолчанию проекта
workers.users.user	node	пользователь
workers.users.user.id	int	идентификатор пользователя из числа исполнителей по умолчанию проекта
workers.users.user.name	string	имя пользователя
workers.groups		корневой элемент списка групп из числа исполнителей по умолчанию проекта
workers.groups.group	node	группа
workers.groups.group.id	int	идентификатор группы
workers.groups.group.name	string	название группы
members		корневой элемент списка участников по умолчанию проекта
auditors		корневой элемент списка аудиторов проекта
customData		значения пользовательских полей проекта
customData.customValue.field.id		идентификатор пользовательского поля
customData.customValue.field.name		название пользовательского поля
customData.customValue.value		значение пользовательского поля
customData.customValue.text		текстовое значение пользовательского поля