|
|
|
|
5pm API is currently in beta. This means that we are still testing and expanding it with new features.
Last updated on: October 21, 2008
Service URL
http://[userdomain].5pmweb.com/api.php
Data format:
-
All XML should be UTF-8 encoded.
-
Date and time values are are in this format: YYYY-MM-DD HH:MM:SS.
-
Booleans are either 1 (true) or 0 (false).
Successful response
<response status="ok|fail">
If fail is returned, then the error text follows in <error> ... </error>
PROJECTS
Response
<?xml version="1.0" encoding="utf-8"?>
<response status="ok">
<items count="10">
<project>
<id>340</id>
<title><![CDATA[Project 1]]></title>
<client_id>0</client_id>
<description></description>
<startdate>2008-08-04 00:00:00</startdate>
<enddate></enddate>
<priority>2</priority>
<status>1</status>
<created>2008-07-30 15:20:25</created>
<timemodify>2008-07-30 15:33:38</timemodify>
<owner_id>8</owner_id>
<notify_project_team>0</notify_project_team>
<notify_client>0</notify_client>
<group_id>91</group_id>
<hidden>0</hidden>
<flag>0</flag>
<team>
<user>0</user>
<user>0</user>
...
</team>
</project>
......
</items>
</response>
# projects count
# project id
# project title
# client id
# project description
# start date
# deadline
# priority
# status
# created time
# modified time
# owner id
# notify project team by email
# notify client by email
# group id
# hide project from non-team members
# mark {0..3}
# team members
Legend:
priority: {1 - 'Low', 2 - 'Normal', 3 - 'High', 4 - 'Urgent'}
status: {1 - 'Open', 2 - 'On Hold', 3 - 'Done'}
TASKS
Response
<?xml version="1.0" encoding="utf-8"?>
<response status="ok">
<items count="162">
<task>
<id>259</id>
<title><![CDATA[Task 1]]></title>
<project_id>1</project_id>
<description></description>
<startdate>2008-07-28 00:00:00</startdate>
<enddate></enddate>
<priority>2</priority>
<status>1</status>
<created>2008-07-28 21:50:34</created>
<timemodify>2008-07-28 21:50:34</timemodify>
<owner_id>1</owner_id>
<notify_project_team>0</notify_project_team>
<notify_task_team>0</notify_task_team>
<notify_client>0</notify_client>
<group_id>0</group_id>
<hidden>0</hidden>
<progress>0</progress>
<hours_done>0</hours_done>
<flag>0</flag>
<team>
<user>0</user>
<user>0</user>
...
</team>
</task>
......
</items>
</response>
# task id
# task title
# parent project id
# task description
# start date
# deadline
# priority
# status
# created time
# modified time
# owner id
# notify project team by email
# notify client by email
# group id
# hide this task from non-team members
# progress {0..100%}
# time done
# mark {0..3}
# team members
GROUPS
Response
<?xml version="1.0" encoding="utf-8"?>
<response status="ok">
<items count="14">
<group>
<id>85</id>
<name><![CDATA[Group 1]]></name>
<description></description>
<owner_id>1</owner_id>
</group>
......
</items>
</response>
USERS
Response
<?xml version="1.0" encoding="utf-8"?>
<response status="ok">
<items count="12">
<user>
<id>1</id>
<first_name><![CDATA[user 1]]></first_name>
<last_name></last_name>
<title><![CDATA[Admin]]></title>
<email>user@5pmweb.com</email>
<adress></adress>
<phone_work></phone_work>
<phone_home></phone_home>
<phone_cell></phone_cell>
<comments></comments>
<level>100</level>
<owner_id>1</owner_id>
<company></company>
</user>
......
</items>
</response>
# user id
# first name
# last name
# nick
# email
# address
# level {0 - Administrator, 100 - User, 150 - External User }
CLIENTS
Response
<?xml version="1.0" encoding="utf-8"?>
<response status="ok">
<items count="5">
<client>
<id>8</id>
<first_name><![CDATA[Client 1]]></first_name>
<last_name><![CDATA[Client 1]]></last_name>
<title></title>
<email>client1@5pmweb.com</email>
<adress></adress>
<phone_work></phone_work>
<phone_home></phone_home>
<phone_cell></phone_cell>
<comments></comments>
<owner_id>3</owner_id>
<company></company>
</client>
......
</items>
</response>
|
|
|
|
|
|
