Loughborough Online Reading List System
NAME GetSURating - Return the number of good/bad ratings from users. DESCRIPTION The GetSURating CGI script allows rating from end users for one or more Structural Units to be returned in XML format. 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. *json* - requests that results be returned in JSON format rather than XML. *callback* - Supplies a JSONP callback. Optional and if given the results are returned in JSONP format rather than XML. Specific for this script *suid* - ID(s) of the root Structural Unit(s) for which we need to return ratings. RESULTS The script returns an XML or JSON/JSONP document (depending on whether *json* or *callback* parameters have been set in the request). The response contains a list of ratings, one rating per structural unit. Each rating specifies the structural unit ID, and counts of the good and bad ratings from that SU. SEE ALSO EditSURating LUMP-XML-Response COPYRIGHT Copyright 2012 Loughborough University Library <email@example.com>. 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.