Editing/ConvertSU

NAME
    ConvertSU - convert a structural unit from one structural unit type to
    another.

DESCRIPTION
    The ConvertSU CGI script allows a LUMP Structural Unit to be converted
    from its current Structural Unit Type to another one, assuming we have a
    suitable set of conversion rules. Note that this conversion can be
    "lossy" because some data types in the original Structural Unit Type may
    not have equivalents in the new Structural Unit Type.

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
    *dump_rules* - If set to non-zero value, return a data structure
    containing all the conversion rules in the system.
    *su_id* - The ID of the structural unit that you are attempting to
    convert. This parameter is mandatory if you wish to do a conversion.
    Note that the user that has been authenticated must have edit rights to
    this SU, otherwise an error will be returned.
    *target_sut_id* - The ID of the Structural Unit Type that you want the
    SU to be changed to. This parameter is mandatory if you wish to do a
    conversion. =back

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
        <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.
Go to Top