project.timer.stop

This method stops and edits the values of a timer.

A project id (which can be retrieved from project.get method) is needed for SUBERNOVA to know which timer to stop.

Call this method via the following URL:

https://app.subernova.com/api/1.0/project.timer.stop

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
This is the id of the project your timer is attached to.
hours
The number of hours to be saved.
minutes
The number of minutes to be saved.
seconds
The number of seconds to be saved.

Response

Success

<?xml version="1.0" encoding="utf-8"?>
  <method request="project.get">
      <project>
         <timer_hour>12</timer_hour>
         <timer_minute>35</timer_minute>
         <timer_seconds>40</timer_seconds>
         <timer_running>0</timer_running>
      </project>
  </method>

Once this method is called, the <timer_running> tag will display 0 to confirm that the timer has stopped running. The current timer hours, minutes and seconds will also be returned in XML format.


Error (no data passed)

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

Error: No data were passed.

Error (timer not stopped)

This short message may be returned if SUBERNOVA's server is down or for some reason the timer cannot be stopped, which is pretty rare.

Error: Timer not stopped.

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.