Usergroups4SU

NAME
    Usergroups4SU - Find the usergroups that are linked to a given SU.

DESCRIPTION
    The Usergroups4SU LUMP API script returns a list of usergroups that are
    associated with a given 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.

  Specific for this script
    *suid* - ID for the structural unit.
    *include_guest* - If set to 'Y' this will allow the Guest usergroup to
    be returned. By default this group isn't included in the results.
    *include_reg* - If set to 'Y' this will allow the Registered Users
    usergroup to be returned. By default this group isn't included in the
    results.

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 (usergroup+)>
     <!ELEMENT usergroup (id|group_name|priority)>
     <!ELEMENT id (#PCDATA)>
     <!ELEMENT group_name (#PCDATA)>
     <!ELEMENT priority (#PCDATA)>

    For example:

     <response>
      <returns>
       <usergroup>
        <id>1</id>
        <group_name>Guests</group_name>
        <priority>0</priority>
       </usergroup>
       <usergroup>
        <id>10</id>
        <group_name>Registered Users</group_name>
        <priority>1</priority>
       </usergroup>
       <usergroup>
        <id>10</id>
        <group_name>Wibblage Reading List Owners</group_name>
        <priority>180</priority>
       </usergroup>
       <usergroup>
        <id>10</id>
        <group_name>Wibblage Reading List Library Assistants</group_name>
        <priority>190</priority>
       </usergroup>
       <usergroup>
        <id>2</id>
        <group_name>Sysadmins</group_name>
        <priority>255</priority>
       </usergroup>

      </returns>
     </response>

SEE ALSO
    GetStructuralUnit

    FindSuid

    EditDataElement

    ListSUTs

    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.