AddFoldertoE-Shelf

Ex Libris Developer Network Primo Documentation Primo REST APIs Web Services – Legacy SOAP (Web Services) E-Shelf AddFoldertoE-Shelf

General Purpose

The eshelf add Folder request adds a specific folder to the e-Shelf.
A success or failure acknowledgement is returned.

WSDL

The WSDL file is located under the following URL:
<your address>:<fe_port>/PrimoWebServices/services/eshelf?wsdl

Input Parameters

Element	Description	Value	Structure
userId	user ID	string	sub-element of getEshelfRequest
institution	institution code	string	sub-element of getEshelfRequest
folderName	the name of the new folder	string	sub-element of getEshelfRequest

Output Parameters

Element	Description	Value	Structure
segments	Root element of the XML tree	no value	root element
jagroot	Element to contain one or several sub-elements (see structure)	no value	sub-element of segments
result	Element to contain one or several sub-elements (see structure)	no value	sub-element of jagroot
error	This element contains the message attribute that contains a success or failure message.	string

Example Input

<addFolderToEshelfRequest xmlns="http://www.exlibris.com/primo/xsd/wsRequest\"  xmlns:uic="http://www.exlibris.com/primo/xsd/primoview/uicomponents\">
        <userId>demo</userId>
        <institution>DEMO</institution>
        <folderName>demo_folder</folderName>
        <parentFolder>2242211</parentFolder>
</addFolderToEshelfRequest>

Example Output

<SEGMENTS xmlns="http://www.exlibrisgroup.com/xsd/jaguar/search">
  <JAGROOT>
    <RESULT>
      <ERROR MESSEGE=" Add Folder to eshelf action completed successfully" CODE="0"/>
    </RESULT>
  </JAGROOT>
</SEGMENTS>