{"id":1001,"date":"2011-06-08T12:17:05","date_gmt":"2011-06-08T12:17:05","guid":{"rendered":"https:\/\/copyright.lboro.ac.uk\/lorls\/?page_id=1001"},"modified":"2011-06-08T12:17:05","modified_gmt":"2011-06-08T12:17:05","slug":"editingallowedsutypes","status":"publish","type":"page","link":"https:\/\/blog.lboro.ac.uk\/lorls\/documentation\/integration\/lumps-apis\/editingallowedsutypes","title":{"rendered":"Editing\/AllowedSUTypes"},"content":{"rendered":"
NAME\n    AllowedSUTypes - LUMP CGI XML API to find Structural Unit Types that are\n    valid children for a given Structural Unit Type *or* Structural Unit.\n\nDESCRIPTION\n    The AllowedSUTypes CGI script permits the valid range of Structural Unit\n    Types that can be children of a particular Structural Unit Type, or\n    children of a Structural Unit (which itself will be of some Structural\n    Unit Type obviously).\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* - The ID of a structural unit. Only used if a *sutid* is not\n    given.\n    *sutid* - The ID of a structural unit type.\n\nRESULTS\n    The script returns the usual LUMP XML format. For successful searches\n    the <error_code> in the <error> section is set to SUCCESS and the\n    <returns> section has a sequence of <child_structural_unit_type>\n    elements, each of which contains <name> and <id> elements that supply\n    the name and ID of a valid child Structural Unit Type. For example:\n\n     <response>\n      <returns>\n       <child_structural_unit_type>\n        <name>Book<\/name>\n        <id>1<\/id>\n       <\/child_structural_unit_type>\n       <child_structural_unit_type>\n        <name>Electronic Resource<\/name>\n        <id>3<\/id>\n       <\/child_structural_unit_type>\n       <child_structural_unit_type>\n        <name>Note<\/name>\n        <id>5<\/id>\n       <\/child_structural_unit_type>\n       <child_structural_unit_type>\n        <name>Journal Article<\/name>\n        <id>6<\/id>\n       <\/child_structural_unit_type>\n       <child_structural_unit_type>\n        <name>Book Chapter<\/name>\n        <id>9<\/id>\n       <\/child_structural_unit_type>\n       <child_structural_unit_type>\n        <name>Journal<\/name>\n        <id>11<\/id>\n       <\/child_structural_unit_type>\n       <child_structural_unit_type>\n        <name>Reading List<\/name>\n        <id>12<\/id>\n       <\/child_structural_unit_type>\n      <\/returns>\n      <session>\n       <security_hash>1248038577:3f79d0a006a8b1b8c7c105ff831981a2<\/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\nSEE ALSO\n    GetStructuralUnit\n\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 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 […]<\/p>\n","protected":false},"author":2,"featured_media":0,"parent":125,"menu_order":21,"comment_status":"closed","ping_status":"closed","template":"page-col-1.php","meta":{"footnotes":"","_links_to":"","_links_to_target":""},"class_list":["post-1001","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\/1001","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=1001"}],"version-history":[{"count":0,"href":"https:\/\/blog.lboro.ac.uk\/lorls\/wp-json\/wp\/v2\/pages\/1001\/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=1001"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}