Ready to Learn?Ex Libris products all provide open APIs

General Purpose

Removes a specific item from the e-shelf

WSDL

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

Input Parameters

The input is a single XML that requests to remove from user's institution from under specific folder e-Shelf document. The parameters that are listed in the input parameters section, such as, userId, institution, docId and folderId are part of this single XML and are not sent as separate parameters.

The following table describes the valid parameters in the XML input request:

ElementDescriptionValueStructure
removeFromEshelfRequestRoot element of the XML treeno valueroot element
userIduser idstringsub-element of removeFromEshelfRequest
institutioninstitution codestringsub-element of removeFromEshelfRequest
docIdrecord id from the PNX tablestringsub-element of removeFromEshelfRequest
folderIdThe folder ID of the subfolder that contains the item.stringsub-element of removeFromEshelfRequest

 

Output

The input is a single XML that requests to remove from user's institution from under specific folder e-Shelf document. The parameters that are listed in the input parameters section, such as, userId, institution, docId and folderId are part of this single XML and are not sent as separate parameters.

The following table describes the valid parameters in the XML input request:

ElementDescriptionValue
segmentsRoot element of the XML tree.no value
jagrootElement to contain one or several sub-elements.
Structure: Sub-element of segments.
no value
resultElement to contain one or several sub-elements.Structure: Sub-element of jagroot.no value
errorThis element contains the message attribute, which contains a success or failure message.string

 

XSD 

 

Example Input

<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:api="http://api.ws.webservices.primo.exlibris.com">
   <soapenv:Header/>
   <soapenv:Body>
      <api:removeFromEshelf soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
         <removeEshelfRequest xsi:type="soapenc:string" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">
&lt;removeFromEshelfRequest xmlns="http://www.exlibris.com/primo/xsd/wsRequest" xmlns:uic="http://www.exlibris.com/primo/xsd/primoview/uicomponents"&gt;
&lt;userId&gt;200&lt;/userId&gt;
&lt;institution&gt;VOLCANO&lt;/institution&gt;
&lt;docId&gt;White_Shore_Voyager31348&lt;/docId&gt;
&lt;folderId&gt;90454049&lt;/folderId&gt;
&lt;/removeFromEshelfRequest&gt;
         </removeEshelfRequest>
      </api:removeFromEshelf>
   </soapenv:Body>
</soapenv:Envelope>
 

Example Output

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org
           /2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
   <soapenv:Body>
      <ns1:removeFromEshelfResponse soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"
                xmlns:ns1="http://api.ws.webservices.primo.exlibris.com">
         <removeFromEshelfReturn xsi:type="soapenc:string"
              xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">
                  <![CDATA[<SEGMENTS xmlns="http://www.exlibrisgroup.com/xsd/jaguar/search">
  <JAGROOT>
    <RESULT>
      <ERROR CODE="0" MESSAGE="Remove from eshelf action completed successfully"/>
    </RESULT>
  </JAGROOT>
</SEGMENTS>]]></removeFromEshelfReturn>
      </ns1:removeFromEshelfResponse>
   </soapenv:Body>
</soapenv:Envelope>