{"id":964,"date":"2011-06-07T15:02:47","date_gmt":"2011-06-07T15:02:47","guid":{"rendered":"https:\/\/copyright.lboro.ac.uk\/lorls\/?page_id=964"},"modified":"2011-06-07T15:02:47","modified_gmt":"2011-06-07T15:02:47","slug":"fastgetstructuralunit","status":"publish","type":"page","link":"https:\/\/blog.lboro.ac.uk\/lorls\/documentation\/integration\/lumps-apis\/fastgetstructuralunit","title":{"rendered":"FastGetStructuralUnit"},"content":{"rendered":"
NAME\n    FastGetStructuralUnit - LUMP CGI XML API to return the contents of a\n    Structural Unit (and its children).\n\nDESCRIPTION\n    The GetStructuralUnit CGI script is designed to allow Structural Units\n    held in a LUMP database to be returned in an XML container format. The\n    script can return a tree of Structural Units to an arbitrary depth\n    rooted at a particular Structural Unit specified by its ID.\n\nPARAMETERS\n  Standard\n    *username* - Name of user running this CGI script. Required unless web\n    server authentication is in use (when it is, the web server\n    authenticated user is used instead).\n    *password* - Password for the user. This is only required if the web\n    server is not handling the user authentication and if no security hash\n    parameter is being given.\n    *security_hash* - An opaque value used to authenticate the user without\n    requiring the password to be sent. This value is generated by a previous\n    execution of a LUMP API script and may well be time limited. It is only\n    required if no password or webserver authentication is done.\n    *act_as* - Users in the SysAdmins group can elect to act on the behalf\n    of other users once they are themselves authenticated. If this parameter\n    is present it should contain the username of the user that should be\n    switched to if this option is available and the real user has been\n    authenticated successfully. Optional.\n    *session_id* - An opaque string as far as the server is concerned that\n    is intended solely to allow async clients to differentiate different\n    results more easily. Optional.\n\n  Specific for this script\n    *suid* - ID of the root Structural Unit for the tree that should be\n    returned. This can be a comma separate list of IDs if more than one\n    Structural Unit is to be found.\n\nRESULTS\n    The script returns an XML document in the standard LUMP response format\n    (as documented in LUMP-XML-Response). The <returns> section's contents\n    depends on the display format requested with the *format* parameter in\n    the request. If this is specified (and isn't \"XML\") the <returns>\n    element will contain a <rendered> element that contains the Structural\n    Unit(s) rendered using the appropriated display format module(s). This\n    means that in this case the value of the <rendered> element can often be\n    transmitted straight into an output stream, DOM element, etc.\n\n    The <returns> element also contains the XML structure following this DTD\n    fragment:\n\n     <!ELEMENT returns (su|rendered)>\n     <!ELEMENT rendered (#PCDATA)>\n     <!ELEMENT su (children|id|structural_unit_type_id|state|deleted|data+)>\n     <!ELEMENT children (su+)>\n     <!ELEMENT structural_unit_type_id (#PCDATA)>\n     <!ELEMENT id (#PCDATA)>\n     <!ELEMENT state (#PCDATA)>\n     <!ELEMENT deleted (#PCDATA)>\n     <!ELEMENT data (data_type|data_element)\n     <!ELEMENT data_element (id|value|modified_time)>\n     <!ELEMENT data_type (id|name|edit_representation|default_value|\n        validation_pattern|repeatable|size)>\n     <!ELEMENT value (#PCDATA)>\n     <!ELEMENT edit_representation (#PCDATA)>\n     <!ELEMENT validation_pattern (#PCDATA)>\n     <!ELEMENT repeatable (#PCDATA)>\n     <!ELEMENT name (#PCDATA)>\n     <!ELEMENT size (#PCDATA)>\n\n    For example:\n\n     <response>\n      <returns>\n       <su>\n        <children>\n         <su>\n          <id>350<\/id>\n          <state>published<\/state>\n          <deleted>N<\/deleted>\n         <\/su>\n        <\/children>\n        <data>\n         <data_type>\n          <validation_pattern><\/validation_pattern>\n          <edit_representation>input text<\/edit_representation>\n          <name>Year<\/name>\n          <id>23<\/id>\n          <repeatable>N<\/repeatable>\n          <size>4<\/size>\n         <\/data_type>\n         <data_element>\n          <value>2006<\/value>\n          <id>1332<\/id>\n         <\/data_element>\n        <\/data>\n        <data>\n         <data_type>\n          <validation_pattern><\/validation_pattern>\n          <edit_representation>input text<\/edit_representation>\n          <name>Semester<\/name>\n          <id>24<\/id>\n          <repeatable>N<\/repeatable>\n          <size>100<\/size>\n         <\/data_type>\n         <data_element>\n          <value><\/value>\n          <id>1333<\/id>\n         <\/data_element>\n        <\/data>\n        <data>\n         <data_type>\n          <validation_pattern><\/validation_pattern>\n          <edit_representation>input text<\/edit_representation>\n          <name>Module Name<\/name>\n          <id>25<\/id>\n          <repeatable>N<\/repeatable>\n          <size>100<\/size>\n         <\/data_type>\n         <data_element>\n          <value>Advanced Human-Computer Integration<\/value>\n          <id>1334<\/id>\n         <\/data_element>\n        <\/data>\n        <data>\n         <data_type>\n          <validation_pattern><\/validation_pattern>\n          <edit_representation>input text<\/edit_representation>\n          <name>Student Numbers<\/name>\n          <id>27<\/id>\n          <repeatable>N<\/repeatable>\n          <size>10<\/size>\n         <\/data_type>\n         <data_element>\n          <value>0<\/value>\n          <id>1335<\/id>\n         <\/data_element>\n        <\/data>\n        <data>\n         <data_type>\n          <validation_pattern>dd[A-Z][A-Z][ABCPX]ddd<\/validation_pattern>\n          <edit_representation>input text<\/edit_representation>\n          <name>Module Code<\/name>\n          <id>28<\/id>\n          <repeatable>N<\/repeatable>\n          <size>10<\/size>\n         <\/data_type>\n         <data_element>\n          <value>06COC171<\/value>\n          <id>1336<\/id>\n         <\/data_element>\n        <\/data>\n        <data>\n         <data_type>\n          <validation_pattern><\/validation_pattern>\n          <edit_representation>input text<\/edit_representation>\n          <name>Module Tutor<\/name>\n          <id>26<\/id>\n          <repeatable>Y<\/repeatable>\n          <size>100<\/size>\n         <\/data_type>\n         <data_element>\n          <value>Professor R S Kalawsky<\/value>\n          <id>1339<\/id>\n         <\/data_element>\n        <\/data>\n        <id>350<\/id>\n       <\/su>\n      <\/returns>\n      <session>\n       <security_hash>1248086710:a615619fd3d278c8a15154afade9ccec<\/security_hash>\n       <lump_version>1<\/lump_version>\n       <acting_as><\/acting_as>\n      <\/session>\n      <error>\n       <error_message>Success<\/error_message>\n       <error_code>SUCCESS<\/error_code>\n      <\/error>\n     <\/response>\n\n    The <error> section contains SUCCESS in the <error_code> if the\n    operation finishes successfully, or a failure error code if it doesn't.\n    The <error_message> element contains a human readable message that can\n    be used to inform the user of problems if desired.\n\nSEE ALSO\n    FindSuid\n\n    LUMP-XML-Response\n\nCOPYRIGHT\n    Copyright 2009 Loughborough University Library <library@lboro.ac.uk>.\n\n    Permission is granted to copy, distribute and\/or modify this document\n    under the terms of the GNU Free Documentation License, Version 1.2 or\n    any later version published by the Free Software Foundation; with no\n    Invariant Sections, with no Front-Cover Texts, and with no Back-Cover\n    Texts.\n\n<\/pre>\n","protected":false},"excerpt":{"rendered":"
NAME FastGetStructuralUnit – LUMP CGI XML API to return the contents of a Structural Unit (and its children). DESCRIPTION The GetStructuralUnit CGI script is designed to allow Structural Units held in a LUMP database to be returned in an XML container format. The script can return a tree of Structural Units to an arbitrary depth […]<\/p>\n","protected":false},"author":2,"featured_media":0,"parent":125,"menu_order":1,"comment_status":"closed","ping_status":"closed","template":"page-col-1.php","meta":{"footnotes":"","_links_to":"","_links_to_target":""},"class_list":["post-964","page","type-page","status-publish","hentry","count-0","even alt","author-lbjlclboro-ac-uk","last"],"_links":{"self":[{"href":"https:\/\/blog.lboro.ac.uk\/lorls\/wp-json\/wp\/v2\/pages\/964","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/blog.lboro.ac.uk\/lorls\/wp-json\/wp\/v2\/pages"}],"about":[{"href":"https:\/\/blog.lboro.ac.uk\/lorls\/wp-json\/wp\/v2\/types\/page"}],"author":[{"embeddable":true,"href":"https:\/\/blog.lboro.ac.uk\/lorls\/wp-json\/wp\/v2\/users\/2"}],"replies":[{"embeddable":true,"href":"https:\/\/blog.lboro.ac.uk\/lorls\/wp-json\/wp\/v2\/comments?post=964"}],"version-history":[{"count":0,"href":"https:\/\/blog.lboro.ac.uk\/lorls\/wp-json\/wp\/v2\/pages\/964\/revisions"}],"up":[{"embeddable":true,"href":"https:\/\/blog.lboro.ac.uk\/lorls\/wp-json\/wp\/v2\/pages\/125"}],"wp:attachment":[{"href":"https:\/\/blog.lboro.ac.uk\/lorls\/wp-json\/wp\/v2\/media?parent=964"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}