Ready to Learn?Ex Libris products all provide open APIs

General Purpose

The eshelf/add request adds a specific item to the e-Shelf.

A success or failure acknowledgement is returned.

Input Parameters

The input is a URL string that adds to user’s institution document in specified folder if requested. If folderId parameter is not provided item is added to root folder.
The following table describes the valid parameters in the URL input request:
 

ParameterDescriptionValue
userIdUser ID.string
institutionInstitution code.string
docIdRecord id from the PNX table.string
folderIdThe folder ID of the subfolder that contains the item.
If the parameter is absent, the root folder is used.
string
searchkey (optional)For remote searches, enter the SEARCHKEY that is returned in the following element of the Brief Search X-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">
 
string

For more information, see Brief Search.
 

Output Parameters

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 error are part of this single XML and are not sent as separate parameters.

The following table describes the valid parameters:
 

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 that contains a success or failure message.string

 

Input Example

http://<primo_server>:<primo_port>/PrimoWebServices/xservice/eshelf/add?institution=DEMO&userId=demo&docId=demo_voyager968394&folderId=172860908&searchkey=10.1.234.323_leukemia_2012-06-05 17:18:39.618

 

Output Example

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