addToEshelfRequest

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

General Purpose

Adds a specific item to the e-shelf

Product Version Compatibility

Version 2.0 and later

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 add to user’s institution e-Shelf document, under specific folder if requested. If folderId is not provided the item is adding automatically to the basket folder. 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:

Element	Description	Possible Values	Structure
AddToEshelfRequest	Root element of the XML tree	no value	root element
userId	user id	string	sub-element of addToEshelfRequest
institution	institution code	string	sub-element of addToEshelfRequest
docId	record id from the PNX table	string	sub-element of addToEshelfRequest
searchkey (optional)	For remote searches, enter the SEARCHKEY that is returned in the following element of the searchRequest Web Service results: <sear:DOCSET SEARCHKEY=”10.1.234.323_leukemia_2012-06-05 17:18:39.618” LASTHIT=”2″ FIRSTHIT=”1″ MAX_TOTALHITS=”675447″ TOTALHITS=”95″> For more information, see searchRequest.	string	sub-element of addToEshelfRequest

Output

The output for this message is an XML response that contains the success or failure acknowledgement for this request. . The parameters that are listed in the output parameters section, such as segments, jagroot etc. are part of this single XML and are not sent as separate parameters.

The following table describes the valid parameters:

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

XSD

<xs:complexType name="AddToEshelfRequest">
   <xs:sequence>
            <xs:element name="docId"  type="xs:string"  minOccurs="0" maxOccurs="unbounded"/>
            <xs:element name="userId"  type="xs:string" maxOccurs="1"/>
            <xs:element name="institution" type="xs:string"  maxOccurs="1"/>
            <xs:element name="folderName"  type="xs:string"  maxOccurs="1"/>
            <xs:element name="folderId"  type="xs:string"  maxOccurs="1"/>
            <xs:element name="pdsHandle"  type="xs:string" maxOccurs="1" minOccurs="0"/>
            <xs:element name="searchKey"  type="xs:string" maxOccurs="1" minOccurs="0"/>
   </xs:sequence>
</xs:complexType>

Example Input

<addToEshelfRequest xmlns="http://www.exlibris.com/primo/xsd/wsRequest\" &nbsp;&nbsp;&nbsp;xmlns:uic="http://www.exlibris.com/primo/xsd/primoview/uicomponents\">
<userId>demo</userId>
<institution>DEMO</institution>
<docId>demo_voyager968394</docId>
</addToEshelfRequest>

Example Output

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