Editing/AllowedSUTypes

NAME
    AllowedSUTypes - LUMP CGI XML API to find Structural Unit Types that are
    valid children for a given Structural Unit Type *or* Structural Unit.

DESCRIPTION
    The AllowedSUTypes CGI script permits the valid range of Structural Unit
    Types that can be children of a particular Structural Unit Type, or
    children of a Structural Unit (which itself will be of some Structural
    Unit Type obviously).

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. Only used if a *sutid* is not
    given.
    *sutid* - The ID of a structural unit type.

RESULTS
    The script returns the usual LUMP XML format. For successful searches
    the <error_code> in the <error> section is set to SUCCESS and the
    <returns> section has a sequence of <child_structural_unit_type>
    elements, each of which contains <name> and <id> elements that supply
    the name and ID of a valid child Structural Unit Type. For example:

     <response>
      <returns>
       <child_structural_unit_type>
        <name>Book</name>
        <id>1</id>
       </child_structural_unit_type>
       <child_structural_unit_type>
        <name>Electronic Resource</name>
        <id>3</id>
       </child_structural_unit_type>
       <child_structural_unit_type>
        <name>Note</name>
        <id>5</id>
       </child_structural_unit_type>
       <child_structural_unit_type>
        <name>Journal Article</name>
        <id>6</id>
       </child_structural_unit_type>
       <child_structural_unit_type>
        <name>Book Chapter</name>
        <id>9</id>
       </child_structural_unit_type>
       <child_structural_unit_type>
        <name>Journal</name>
        <id>11</id>
       </child_structural_unit_type>
       <child_structural_unit_type>
        <name>Reading List</name>
        <id>12</id>
       </child_structural_unit_type>
      </returns>
      <session>
       <security_hash>1248038577:3f79d0a006a8b1b8c7c105ff831981a2</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>

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.