Planfix API: project.get

From PlanFix
Jump to: navigation, search

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 whether or not the project is hidden whether or not it's displayed in the main list
hasEndDate bool true/false - does the project have a due date
endDate DateTime project due date only used if the flag hasEndDate is set
beginDate DateTime project creation date
taskCount int number of tasks in the project
isOverdued bool true/false - is the project overdue
isCloseToDeadline bool true/false time left until deadline is 25%, or 75% of dedicated time has passed
workers root element of the project default assignee list
workers.users root element of the list of users from the project default assignees
workers.users.user node user
workers.users.user.id int project default assignee user id
workers.users.user.name string username
workers.groups root element of the list of groups from the project default assignees
workers.groups.group node group
workers.groups.group.id int group identifier
workers.groups.group.name string group name
members root element of the project default participant list
auditors root element of the project auditors list
customData project custom field values
customData.customValue.field.id custom field identifier
customData.customValue.field.name custom field name
customData.customValue.value custom field value
customData.customValue.text text value of the custom field

Otherwise, an error response will be returned:

<?xml version="1.0" encoding="UTF-8"?>
<response status="error">
  <code></code>
</response>


Go To