Loughborough Online Reading List System
NAME CopySU - copy a structural unit DESCRIPTION The CopySU CGI script allows a LUMP Structural Unit to be copied. 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 *source_su_id* - The ID of the structural unit that you are copying from. This parameter is mandatory. *target_su_id* - The ID of another structural unit that the copied SU will appear under. This parameter is mandatory. Note that the user that has been authenticated must have edit rights to this SU, otherwise an error will be returned. *levels* - How many levels of child structural units that to copy over. Default is 0. If -1 is specified then it copies all children under the source_su_id. *copy_or_link* - If given the value 'link' then a link is made to the source structural unit, otherwise a copy is made. Copying is the default. A link basically means that the SU with the *source_su_id* ID has a new entry made in the structural_unit_link table pointing at the *target_su_id* so that it has multiple parents. *rank* - The rank you'd like to give the copied/linked SU in the list of children of the target SU. Defaults to 0. 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.