Get E-Shelf
General Purpose
The eShelf/get request returns the content of a specific user’s e-Shelf.
Input Parameters
| Parameter | Description | Value |
|---|---|---|
| userId | User ID. | string |
| institution | Institution code. | string |
| getDelivery | If set to true, this parameter requests GetIt data. | false or true |
Output 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 |
| querytransformations | Element to contain one or several sub-elements. Structure: Sub-element of result. | no value |
| querytransformation | Element to contain one or several sub-elements. Structure: Sub-element of queryTransformations. | no value |
| action | did_u_mean. Structure: Sub-element of queryTransformation. | any value |
| query | Alternative spelling of the search term. Structure: Sub-element of queryTransformation. | any value |
| docset | Element to contain one or several sub-elements. Structure: Sub-element of result. | no value |
| total_time | Time used by the search engine to retrieve results. Structure: Sub-element of docset. | any number |
| totalhits | Number of results found by search. Structure: Sub-element of docset. | any number |
| doc | Element to contain one or several sub-elements. Structure: Sub-element of docset. | no value |
| local | Defines if search was done locally or remotely. Structure: Sub-element of doc. | “true” or “false” Default: true |
| pnx:PrimoNMBib | Element to contain one or several sub-elements. Default: true | |
| FOLDER | folder name and code. Structure: Sub-element of doc. | no value |
| record | Details about how the internal structure of a PNX can be found in the Primo Technical Guide. |
Input Example
http://primo:170x/PrimoWebServices/xservice/eshelf/get?userId=demo&institution=VOLCANO&getDelivery=true
Output Example
<SEGMENTS xmlns="http://www.exlibrisgroup.com/xsd/jaguar/search">
<JAGROOT>
<RESULT>
<DOCSET TOTALHITS="4">
<sear:DOC LOCAL="true" xmlns="http://www.exlibrisgroup.com/xsd/primo/primo_nm_bib" xmlns:sear="http://www.exlibrisgroup.com/xsd/jaguar/search">
<PrimoNMBib>
<record>
<control>
<sourcerecordid>000250494</sourcerecordid>
<sourceid>primo_aleph</sourceid>
...
</control>
<display>
<type>book</type>
<title>The impact of the war on community leadership and opinion in Red Wing,</title>
...
</display>
<links>
<openurl>$$Topenurl_journal</openurl>
<backlink>$$Taleph_backlink$$Ebacklink</backlink>
...
</links>
<search>
<creatorcontrib>F. Chapin (Francis Stuart), 1888-</creatorcontrib>
<creatorcontrib>Chapin, F</creatorcontrib>
...
</search>
<sort>
<title>impact of the war on community leadership and opinion in Red Wing,</title>
<creationdate>1945</creationdate>
<author>Chapin, F. Stuart (Francis Stuart), 1888-</author>
</sort>
<facets>
<language>und</language>
<creationdate>1945</creationdate>
...
</facets>
<dedup>
<t>1</t>
<c1>a45002206</c1>
<c3>impactofthewaroncommninredwing</c3>
<c4>1945</c4>
...
</dedup>
<frbr>
<t>1</t>
<k1>$$Kchapin f stuart francis stuart 1888$$AA</k1>
<k3>$$Kimpact of the war on community leadership and opinion in red wing$$AT</k3>
</frbr>
<delivery>
<institution>VOLCANO</institution>
<delcategory>Physical Item</delcategory>
</delivery>
<enrichment>
<classificationlcc>HN80.R4</classificationlcc>
</enrichment>
<ranking>
<booster1>1</booster1>
<booster2>1</booster2>
</ranking>
<addata>
<aulast>Chapin</aulast>
<aufirst>F.</aufirst>
...
</addata>
</record>
</PrimoNMBib>
<sear:GETIT GetIt2="http://qa-server02:3210/sfxlcl3?ctx_ver=Z39.88-2004&ctx_enc=info:ofi/enc:UTF-8&ctx_tim=2010-12-20T10%3A49%3A17IST&url_ver=Z39.88-2004&url_ctx_fmt=infofi/fmt:kev:mtx:ctx&rfr_id=info:sid/primo.exlibrisgroup.com:primo3-Journal-primo_aleph&rft_val_fmt=info:ofi/fmt:kev:mtx:book&rft.genre=book&rft.atitle=&rft.jtitle=&rft.btitle=The%20impact%20of%20the%20war%20on%20community%20leadership%20and%20opinion%20in%20Red%20Wing,&rft.aulast=Chapin&rft.auinit=&rft.auinit1=&rft.auinitm=&rft.ausuffix=&rft.au=Chapin,%20F.%20Stuart%20(Francis%20Stuart),%201888-&rft.aucorp=&rft.volume=&rft.issue=&rft.part=&rft.quarter=&rft.ssn=&rft.spage=&rft.epage=&rft.pages=&rft.artnum=&rft.issn=&rft.eissn=&rft.isbn=&rft.sici=&rft.coden=&rft_id=info:doi/&rft.object_id=&rft_dat=<primo_aleph>000250494</primo_aleph>&rft.eisbn=&rft_id=info:oai/" GetIt1="http://qa-server03.corp.exlibrisgroup.com:8991/F?func=item-global&doc_library=USM01&local_base=USM01&doc_number=000250494" deliveryCategory="Physical Item"/>
<sear:LIBRARIES>
<sear:LIBRARY>
<sear:institution>VOLCANO</sear:institution>
<sear:library/>
...
</sear:LIBRARY>
<sear:LIBRARY>
<sear:institution>VOLCANO</sear:institution>
<sear:library/>
...
</sear:LIBRARY>
<sear:LIBRARY>
<sear:institution>VOLCANO</sear:institution>
<sear:library/>
...
</sear:LIBRARY>
</sear:LIBRARIES>
<sear:LINKS>
<sear:openurl><![CDATA[></sear:openurl>
<sear:backlink></sear:backlink>
<sear:thumbnail></sear:thumbnail>
<sear:openurlfulltext><![CDATA[></sear:openurlfulltext>
<sear:linktoholdings></sear:linktoholdings>
</sear:LINKS>
<sear:FOLDER folderName="Basket" folderId="2081555"/>
</sear:DOC>
<sear:DOC LOCAL="true" xmlns="http://www.exlibrisgroup.com/xsd/primo/primo_nm_bib" xmlns:sear="http://www.exlibrisgroup.com/xsd/jaguar/search">
<PrimoNMBib>
<record>
<control>
<sourcerecordid>000068167</sourcerecordid>
<sourceid>primo_aleph</sourceid>
...
</control>
<display>
<type>book</type>
<title>The red cougar, or, Little Fox-fire's last trail</title>
<creator>T. C. Harbaugh (Thomas Chalmers), 1849-1924.</creator>
...
...
...
</sear:DOC>
</DOCSET>
</RESULT>
</JAGROOT>
</SEGMENTS>