Editing/EditDataElement

NAME
    EditDataElement - edit a particular data element

DESCRIPTION
    The EditDataElement CGI script allows the value to be created/edited for
    a data element 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. Required.
    *data_type_name* - Name of the data type associated with this data
    element.
    *data_type_id* - ID of the data type associated with this data element.
    Only need to choose between this and *data_type_name* if creating a new
    data element.
    *data_element_value* - The value to be given to this data element.
    *data_element_id* - The ID of the data element. Required if editing an
    existing data element.
    *replace* - A boolean value indicating if an existing element should be
    replaced if it is of a non-repeatable type. If this is set to 'N' and a
    non-repeatable data type is specified for which a data element already
    exists, an error will be returned. If set to 'Y' and an existing data
    element for a non-repeating data type is found, this is deleted before
    the new data element is created.

RESULTS
    For successful operations, the LUMP XML <returns> section has a
    <data_element_id> element set with the ID of the data element that has
    been created or edited.

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