Version 1.1 API Documentation

Status Code list

Status Codes
  • The list of Status codes and their descriptions so that you can build your app to handle these exceptions.

Debugging

If you need to disable sessions temporarily then in the MobileConfig.php Then
set debug sessions =1, now for any call that requires a session id (sid), just pass nosession=1 edit
$debug_sessions = 1 

you will also need to pass uid=#. # being whatever your user id or another persons user id is so you can mimic that users session.

Sample: Mobile/projects/get?nosession=1&uid=1

I set it up this way so that you could then go back to using sessions by not calling nosession=1 so you can work on the sessions per api call.

If for any reason any of the apis are blank or appear to have an issue set debug =1 ,
 $debug =1 

and then for whichever api call is having the issue just add &debug=1 to show the debug information.

API Calls

/Mobile/
  • This is the validate call, you generally call this from your app to verify that the site you are hitting is compatible for the mobile app. I have been debating adding a Version to this so that you can have your app do version checks, and hope anyone who alters the code and puts it up changes it.

/Mobile/administration/project/addUser
  • After looking at the adminstrator page for projects, the only thing different between administration of a project and project branch below is the ability to add user's to a project. So that is the only thing I have added here. Use the project branch for everything else project related.
Note: It is possible that in the future I will move this to the project branch

/Mobile/login/
  • Logs in the user that is passed. Returns a sessionid that you will need to store.

/Mobile/logout/
  • Logs the user out, and destroys the session.

/Mobile/projects/add
  • Add a new project

/Mobile/projects/del
  • deletes a project

/Mobile/projects/edit
  • edits a project

/Mobile/projects/get
  • Retrieve projects

/Mobile/projects/open
  • Open a project

/Mobile/projects/close
  • Close a project

/Mobile/projects/milestones/add
  • Add a new milestone

/Mobile/projects/milestones/del
  • Deletes a milestone

/Mobile/projects/milestones/edit
  • Edits a milestone

/Mobile/projects/milestones/get
  • Get milestones

/Mobile/projects/milestones/open
  • Opens a milestone

/Mobile/projects/milestones/close
  • Closes a milestone

/Mobile/projects/tasklists/add
  • Adds a new tasklist

/Mobile/projects/tasklists/del
  • Deletes a tasklist

/Mobile/projects/tasklists/edit
  • Edits a tasklist

/Mobile/projects/tasklists/get
  • Get tasklists

/Mobile/projects/tasklists/open
  • Opens a tasklist

/Mobile/projects/tasklists/close
  • Close a tasklist

/Mobile/projects/tasks/add
  • Adds a new task

/Mobile/projects/tasks/del
  • Deletes a task

/Mobile/projects/tasks/edit
  • Edits a task

/Mobile/projects/tasks/get
  • Get tasks

/Mobile/projects/tasks/open
  • Opens a task

/Mobile/projects/tasks/close
  • Closes a task

/Mobile/roles/get
  • Get permissions for a specific role

Last edited Feb 22, 2012 at 8:35 PM by darxval, version 6

Comments

No comments yet.