Editing/SUEditingInfo

NAME
    SUEditingInfo - For a given Structural Unit return an XML document
    describing the available Data Type Groups and Data Types.

DESCRIPTION
    The SUEditingInfo LUMP API CGI script provides information on the
    available Data Type Groups and Data Types that a permissible for a
    particular 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 being examined. Required.

RESULTS
    A successful search will return a LUMP XML document where the <returns>
    section is filled in with a list of <data_type_group> elements. Each of
    these will have a <title>, <id> and <rank> element, as well as a list of
    associated <data_type> elements. Each <data_type> element contains the
    following elements describing the Data Type and how Data Elements of
    that Data Type can be created: <name>, <id>, <default_value>,
    <validation_pattern>, <edit_representation>, <repeatable> and <size>.

    For example:

     <response>
      <returns>
       <data_type_group>
        <data_type>
         <validation_pattern>d+</validation_pattern>
         <edit_representation>input text</edit_representation>
         <default_value></default_value>
         <name>Moodle ID</name>
         <id>127</id>
         <repeatable>N</repeatable>
         <size>10</size>
        </data_type>
        <data_type>
         <validation_pattern></validation_pattern>
         <edit_representation>input text</edit_representation>
         <default_value></default_value>
         <name>Reading List Name</name>
         <id>128</id>
         <repeatable>N</repeatable>
         <size>255</size>
        </data_type>
        <title>Reading List Details</title>
        <id>32</id>
        <rank>0</rank>
       </data_type_group>
      </returns>
      <session>
       <security_hash>1248082076:00bf15ceccbe4a857b7dbc142554c58a</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

    EditDataElement

    EditStructuralUnit

    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.