starting on VCL-33

[Josh Thompson <jo...@ncsu.edu>]

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

I'm going to start on VCL-33 (add user group management to XML RPC API).  
Below are the functions I plan to add.  Let me know if you have any 
suggestions for additional function or differences in these functions.

Josh


XMLRPCaddUserGroup
parameters:
  name - name of user group
  affiliation - affiliation of user group
  owner - user that will be the owner of the group in username@affiliation
          form
  managingGroup - user group that can manage membership of this one
  initialMaxTime - (minutes) max initial time users in this group can select 
                   for length of reservations
  totalMaxTime - (minutes) total length users in the group can have for a 
                 reservation (including all extensions)
  maxExtendTime - (minutes) max length of time users can request as an 
                  extension to a reservation at a time

returns: array with these keys:
  status - either "success" or "error"
  if error, then additionally an error code and message

description:
  creates a new user group with the specified parameters



XMLRPCgetUserGroupAttributes
parameters:
  name - name of user group
  affiliation - affiliation of user group

returns: array with these keys:
  status - either "success" or "error"
  if error, then additionally an error code and message
  if success, then these additional keys:
    owner - user that will be the owner of the group in username@affiliation
            form
    managingGroup - user group that can manage membership of this one
    initialMaxTime - (minutes) max initial time users in this group can select 
                     for length of reservations
    totalMaxTime - (minutes) total length users in the group can have for a 
                   reservation (including all extensions)
    maxExtendTime - (minutes) max length of time users can request as an 
                    extension to a reservation at a time

description:
  gets information about a user group



XMLRPCdeleteUserGroup
parameters:
  name - name of user group
  affiliation - affiliation of user group

returns:  array with these keys:
  status - either "success" or "error"
  if error, then additionally an error code and message

description:
  deletes a user group along with all of its privileges



XMLRPCeditUserGroup
parameters:
  name - name of user group
  affiliation - affiliation of user group
  newname - new name for user group
  newaffiliation - new affiliation for user group
  newowner - user that will be the owner of the group in username@affiliation 
             form
  newmanagingGroup - user group that can manage membership of this one
  newinitialMaxTime - (minutes) max initial time users in this group can 
                      select for length of reservations
  newtotalMaxTime - (minutes) total length users in the group can have for a 
                    reservation (including all extensions)
  newmaxExtendTime - (minutes) max length of time users can request as an 
                     extension to a reservation at a time
  note: an empty string may be passed for any of the new* fields to leave that 
        item unchanged

returns: array with these keys:
  status - either "success" or "error"
  if error, then additionally an error code and message

description:
  modifies attributes of a user group



XMLRPCgetUserGroupMembers
parameters:
  name - name of user group
  affiliation - affiliation of user group

returns: array with these keys:
  status - either "success" or "error"
  if error, then additionally an error code and message
  if success, then an additional key "members" that is an array of members of 
the group in username@affiliation form

description:
  gets members of a user group


XMLRPCaddUsersToGroup
parameters:
  name - name of user group
  affiliation - affiliation of user group
  users - array of users in username@affiliation form to be added to the group

returns: array with these keys:
  status - either "success", "warning", or "error"
  if error, then additionally an error code and message
  if warning, then an additional key "failedusers" that is an array of users 
in username@affiliation form that could not be added

description:
  adds users to a group



XMLRPCremoveUsersFromGroup
parameters:
  name - name of user group
  affiliation - affiliation of user group
  users - array of users in username@affiliation form to be removed from the
          group

returns: array with these keys:
  status - either "success", "warning", or "error"
  if error, then additionally an error code and message
  if warning, then an additional key "failedusers" that is an array of users 
in username@affiliation form that could not be removed

description:
  removes users from a group

- -- 
- -------------------------------
Josh Thompson
Systems Programmer
Virtual Computing Lab (VCL)
North Carolina State University

Josh_Thompson@ncsu.edu
919-515-5323

my GPG/PGP key can be found at pgp.mit.edu
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.4.6 (GNU/Linux)

iD8DBQFJwluNV/LQcNdtPQMRAgVlAJ9zQwY7qMsYVW5+w6BByhAmTSIyCQCfQTLc
gHbfV3AL7nFCMlLE4ECaZGc=
=NBjw
-----END PGP SIGNATURE-----