From 0f9588cdf4ab5c36ed5f5300d7192bb70d063c81 Mon Sep 17 00:00:00 2001
From: james <james>
Date: Mon, 27 Sep 2010 20:45:57 +0000
Subject: [PATCH] Add APIDOC for the rest of the existing api

---
 api.php | 24 ++++++++++++++++++++++--
 1 file changed, 22 insertions(+), 2 deletions(-)

diff --git a/api.php b/api.php
index 40e9d0c6..4f3704f6 100644
--- a/api.php
+++ b/api.php
@@ -230,6 +230,10 @@ switch($request[0]) {
 		switch($request[1]) {
 			case "teams":
 				switch($request[2]) {
+					/*	APIDOC: scienceolympics/teams/list
+						description(lists the schools science olympics teams)
+						return(teams array)
+					*/
 					case "list":
 						$q=mysql_query("SELECT id,name FROM so_teams WHERE schools_id='{$u['schools_id']}' AND conferences_id='{$conference['id']}'");
 						$ret['status']='ok';
@@ -239,9 +243,15 @@ switch($request[0]) {
 						}
 						$ret['teams']=$teams;
 					break;
+					/*	APIDOC: scienceolympics/teams/add
+						description(add a science olympics team to the logged in teacher's school)
+						post(teamname varchar(64))
+						return(team array);
+					*/
 					case "add":
 						if($_POST['teamname']) {
-							if(so_team_add($school_id,$conference['id'],$_POST['teamname'])) {
+							if($team=so_team_add($school_id,$conference['id'],$_POST['teamname'])) {
+								$ret['team']=$team;
 								$ret['status']="ok";
 							}
 							else {
@@ -253,10 +263,16 @@ switch($request[0]) {
 								$ret['error']='teamname (varchar 64) is required';
 						}
 					break;
+					/*	APIDOC: scienceolympics/teams/edit
+						description(edit a science olympics team)
+						post(id integer, teamname varchar(64))
+						return(team array);
+					*/
 					case "edit":
 						if($_POST['id'] && $_POST['teamname']) {
-							if(so_team_edit($school_id,$_POST['id'],$_POST['teamname'])) {
+							if($team=so_team_edit($school_id,$_POST['id'],$_POST['teamname'])) {
 								$ret['status']="ok";
+								$ret['team']=$team;
 							}
 							else {
 								$ret['status']='error';
@@ -268,6 +284,10 @@ switch($request[0]) {
 								$ret['error']='id (integer), teamname (varchar 64) are required';
 						}
 					break;
+					/*	APIDOC: scienceolympics/teams/delete
+						description(delete a science olympics team)
+						post(id integer)
+					*/
 					case "delete";
 						if($_POST['id']) {
 							if(so_team_delete($school_id,$_POST['id'])) {