Loughborough Online Reading List System
Editing/EditSURating
NAME
EditSURating - edit the rating for a structural unit for the current
user.
DESCRIPTION
The EditSURating CGI script permits a Good/Bad rating indication to be
created between a user and a structural unit.
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 for the Structural Unit. Required.
*rating* - This needs to be set to either "good" or "bad" to indicate
the rating the user wished to attach to this structural unit. Required.
RESULTS
For successful operations, the LUMP XML <returns> section has a <rating>
element set with that returns the current rating summary for the given
structural unit. By specifying the *json* or *callback* parameters in
the request, the response can be returned in JSON or JSONP format rather
than XML if required.
SEE ALSO
GetSURating
LUMP-XML-Response
COPYRIGHT
Copyright 2012 Loughborough University Library <library@lboro.ac.uk>.
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.