project.get

This method retrieves either all projects and their data or just one project and their data from the user's account, depending if parameter "id" is passed with the call.

Call this method via the following URL:

https://app.subernova.com/api/1.0/project.get

Parameters

These are the parameters you can pass with the call:

api_key
Your API key for authentication. This can be found in your account settings.
id (optional)
This parameter is the project's id. This parameter is used only if you wish to retrieve data of just one project.
archives (optional)
By default, only active projects (excluding archives) are returned. Unless you set this parameter to 1.

Response

Success (no id was passed)

When no id is passed, every single project and its data that belongs to your account will be returned in XML format.

<?xml version="1.0" encoding="utf-8"?>
  <method request="project.get">
      <project>
         <id>1092</id>
         <name>Web Development</name>
         <description>Programming for website</description>
         <users>
            <user id="290109" shared="0">Jessica Anderson</user>
            <user id="192983" shared="1">Gerard Peters</user>
         </users>
         <client id="9010">Starbucks Inc</client>
         <base_price>5500</base_price>
         <extra_price>100</extra_price>
         <quoted>0</quoted>
         <invoiced>1</invoiced>
         <paid>0</paid>
         <start_date>1267804800</start_date>
         <deadline>1267891200</deadline>
         <archive>0</archive>
         <timer_hour>12</timer_hour>
         <timer_minute>35</timer_minute>
         <timer_seconds>40</timer_seconds>
         <timer_running>1</timer_running>
      </project>
      
      <project>
         <id>152</id>
         <name>Code HTML</name>
         <description>HTML coding for the project.</description>
         <users>
            <user id="392993" shared="1">Jessica Anderson</user>
            <user id="880102" shared="1">Gerard Peters</user>
         </users>
         <client id="8503">MTV Corp</client>
         <base_price>2300</base_price>
         <extra_price>78</extra_price>
         <quoted>1</quoted>
         <invoiced>0</invoiced>
         <paid>0</paid>
         <start_date>1267804500</start_date>
         <deadline>1267894100</deadline>
         <archive>0</archive>
         <timer_hour>0</timer_hour>
         <timer_minute>0</timer_minute>
         <timer_seconds>0</timer_seconds>
         <timer_running>0</timer_running>
      </project>
  </method>

Start date and deadline are returned as a unix timestamp.

It's worth noting that SUBERNOVA's timer runs irregardless of whether the app is closed. If your timer is already running, the timer hours, minutes and seconds tags will display the real time numbers of the live timer currently displayed in your SUBERNOVA account. In your custom application, take the timer values and display it in your timer and start running your timer immmediately. This way, your application's timer and your SUBERNOVA account's timer will sync seamlessly.

The <timer_running> tag shows 1 if the timer is currently running and 0 if it's not running. So you know if you should start running your timer immediately or not.


Success (a project id was passed)

If you pass an id with the call, you'll receive XML data of that project only.

<?xml version="1.0" encoding="utf-8"?>
  <method request="project.get">
      <project>
         <id>1092</id>
         <name>Web Development</name>
         <description>Programming for website</description>
         <client_id>152</client_id>
         <base_price>5500</base_price>
         <extra_price>100</extra_price>
         <quoted>0</quoted>
         <invoiced>1</invoiced>
         <paid>0</paid>
         <start_date>1267804800</start_date>
         <deadline>1267891200</deadline>
         <archive>0</archive>
         <timer_hour>12</timer_hour>
         <timer_minute>35</timer_minute>
         <timer_seconds>40</timer_seconds>
         <timer_running>1</timer_running>
      </project>
  </method>

Success (no projects found)

This short message will be returned if no projects were found.

Success: No projects found.

Error (no data passed)

This short message will be returned if no data were passed with the call.

Error: No data were passed.

Error (invalid API key)

This short message will be returned if the API key passed with the call is invalid.

Error: API key is invalid.

Error (account expired)

This short message will be returned if your account has expired.

Error: Account expired.

Help

If you have any questions regarding our API or found a bug, please send us a support request.