Add not implemented API comments of what still needs to get done

This commit is contained in:
james 2010-09-28 19:48:03 +00:00
parent cbcb1743ce
commit eb3c8f0d77

40
api.php
View File

@ -324,4 +324,44 @@ switch($request[0]) {
}
echo json_encode($ret);
/* APIDOC: zNOTIMPLEMENTED_school/list
description(list schools)
return(schools array)
*/
/* APIDOC: zNOTIMPLEMENTED_account/edit
description(edit account information)
post(account array)
return(account array)
*/
/* APIDOC: zNOTIMPLEMENTED_user/edit
description(edit user information for current conference)
post(user array)
return(user array)
*/
/* APIDOC: zNOTIMPLEMENTED_user/connect_teacher_to_school
description(connects the current users teacher role to the specified school usign the schools access code)
post(schools_id integer, accesscode varchar(16))
return(school array)
*/
/* APIDOC: zNOTIMPLEMENTED_role/list
description(list roles and their corresponding registration types)
return(roles array)
*/
/* APIDOC: zNOTIMPLEMENTED_role/add
post(role_id integer, password varchar(64) optional)
description(add a role for the user to the current conference. Depending on the registraiton type, an optional password (singlepassword, schoolpassword, etc) can be specified)
return(role array)
*/
/* APIDOC: zNOTIMPLEMENTED_role/remove
post(role_id integer)
description(remove a role from the user for the current conference)
return(role array)
*/
?>