Loughborough Online Reading List System
NAME RankSUs - re-rank a collection of structural units DESCRIPTION The RankSUs CGI script allows the ranking for a set of LUMP Structural Units to be managed. PARAMETERS Standard *username* - Name of user running this CGI script. Required unless web server authentication is in use (when it is, the web server authenticated user is used instead). *password* - Password for the user. This is only required if the web server is not handling the user authentication and if no security hash parameter is being given. *security_hash* - An opaque value used to authenticate the user without requiring the password to be sent. This value is generated by a previous execution of a LUMP API script and may well be time limited. It is only required if no password or webserver authentication is done. *act_as* - Users in the SysAdmins group can elect to act on the behalf of other users once they are themselves authenticated. If this parameter is present it should contain the username of the user that should be switched to if this option is available and the real user has been authenticated successfully. Optional. *session_id* - An opaque string as far as the server is concerned that is intended solely to allow async clients to differentiate different results more easily. Optional. Specific for this script *parent_su_id* - the structural unit ID of the parent SU under which all this ranking is taking place. For example it might be a reading list SU ID, and ranking will be for books, journals, etc underneath it. This is a required parameter. *suid_rank_pairs* - a comma separated list of structural unit ID and rank number pairs, with the SU IDs and ranks separated themselves using colons. Eg: 1435:10,3456:20,45642:30. This is a required parameter. RESULTS The <returns> section of the XML result is empty and the <error_code> is used to indicate success or failure of the operation. SEE ALSO GetStructuralUnit FindSuid LUMP-XML-Response COPYRIGHT Copyright 2009 Loughborough University Library <firstname.lastname@example.org>. Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.2 or any later version published by the Free Software Foundation; with no Invariant Sections, with no Front-Cover Texts, and with no Back-Cover Texts.