getEshelfRequest

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

General Purpose

Provides the content of the e-shelf of a specific user

WSDL

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

Input Parameters

Element	Description	Value	Structure
getEshelfRequest	Root element of the XML tree	no value	root element
userId	user ID	string	sub-element of getEshelfRequest
institution	institution code	string	sub-element of getEshelfRequest
getDelivery	If set to true, this parameter requests GetIt data.	false or true	sub-element of getEshelfRequest
folderId	e-Shelf folder ID	string	sub-element of getEshelfRequest

Output

Element	Description	Value	Default	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
docset	Element to contain one or several sub-elements (see structure)	no value		sub-element of result
totalhits	number of results found by search	any number		sub-element of docset
doc	Element to contain one or several sub-elements (see structure)	no value		sub-element of docset
local	defines if a result is local or remote	“true” or “false”	true	sub-element of doc
pnx:PrimoNMBib	Element to contain one or several sub-elements (see structure)	no value		sub-element of doc
record	Details about how the internal structure of a PNX can be found in the technical guide

Response

Returns results list of a specific user’s EShelf.

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:getEshelf soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
         <getEshelfRequest xsi:type="soapenc:string" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">
             &lt;getEshelfRequest 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;getDelivery&gt;true&lt;/getDelivery&gt;
             &lt;/getEshelfRequest&gt;
        </getEshelfRequest>
      </api:getEshelf>
   </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:getEshelfResponse soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="http://api.ws.webservices.primo.exlibris.com">
            <getEshelfReturn xsi:type="soapenc:string" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">
                <![CDATA[
                    <sear:SEGMENTS xmlns:sear="http://www.exlibrisgroup.com/xsd/jaguar/search">
                        <sear:JAGROOT>
                            <sear:RESULT>
                                <sear:DOCSET TOTALHITS="1">
                                    <sear:DOC LOCAL="true">
                                        <PrimoNMBib xmlns="http://www.exlibrisgroup.com/xsd/primo/primo_nm_bib">
                                            <record>
                                                (for more information on record data, see: http://www.exlibrisgroup.com/xsd/primo/primo_nm_bib)
                                            </record>
                                        </PrimoNMBib>
                                    </sear:DOC>
                                </sear:DOCSET>
                            </sear:RESULT>
                        </sear:JAGROOT>
                    ]]>
                </sear:SEGMENTS>
            </getEshelfReturn>
        </ns1:getEshelfResponse>
    </soapenv:Body>
</soapenv:Envelope>

NOTE: The DOCSET node will contain the PrimoNMBib – normalized Bib record