Ready to Learn?Ex Libris products all provide open APIs

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

ElementDescriptionValueStructure
userIduser IDstringsub-element of getEshelfRequest
institutioninstitution codestringsub-element of getEshelfRequest
folderNamethe name of the new folderstringsub-element of getEshelfRequest

Output

ElementDescriptionValueDefaultStructure
segmentsRoot element of the XML treeno value root element
jagrootElement to contain one or several sub-elements (see structure)no value sub-element of segments
resultElement to contain one or several sub-elements (see structure)no value sub-element of jagroot
errorThis element contains the message attribute that contains a success or failure message.string  

Example Input

        <userId>demo</userId>
        <institution>DEMO</institution>
        <folderName>demo_folder</folderName>
        <parentFolder>2242211</parentFolder>
</addFolderToEshelfRequest>


 

Example Output

  <JAGROOT>
    <RESULT>
      <ERROR MESSEGE=" Add Folder to eshelf action completed successfully" CODE="0"/>
    </RESULT>
  </JAGROOT>
</SEGMENTS>