Loughborough Online Reading List System
NAME ListSUTs - LUMP CGI XML API to return a list of available Structural Unit Types DESCRIPTION The ListSUTs CGI script is designed to list Structural Units Types held in a LUMP database in an XML container 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. Specific for this script *suid* - The ID of a structural unit. Optional. *sutid* - The ID of a structural unit type. Optional. RESULTS The script returns an XML document in the standard LUMP response format (as documented in LUMP-XML-Response). The <returns> section's contains the XML structure following this DTD fragment: <!ELEMENT returns (sut+)> <!ELEMENT sut (id|name|child_structural_unit_type)> <!ELEMENT child_structural_unit_type (id|name)> <!ELEMENT id (#PCDATA)> <!ELEMENT name (#PCDATA)> For example: <response> <returns> <sut> <id>11</id> <name>Institution</name> <child_structural_unit_type> <id>9</id> <name>Faculty</name> </child_structural_unit_type> </sut> </returns> <session> <security_hash>1248086710:a615619fd3d278c8a15154afade9ccec</security_hash> <lump_version>1</lump_version> <acting_as></acting_as> </session> <error> <error_message>Success</error_message> <error_code>SUCCESS</error_code> </error> </response> The <error> section contains SUCCESS in the <error_code> if the operation finishes successfully, or a failure error code if it doesn't. The <error_message> element contains a human readable message that can be used to inform the user of problems if desired. SEE ALSO FindSuid GetStructuralUnit LUMP-XML-Response COPYRIGHT Copyright 2009 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.