Ready to Learn?Ex Libris products all provide open APIs

General Purpose

The eShelf/get request returns the content of a specific user's e-Shelf.

Input Parameters

ParameterDescriptionValue
userIdUser ID.string
institutionInstitution code.string
getDeliveryIf set to true, this parameter requests GetIt data.false or true

 

Output 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
querytransformationsElement to contain one or several sub-elements.
Structure: Sub-element of result.
no value
querytransformationElement to contain one or several sub-elements.
Structure: Sub-element of queryTransformations.
no value
actiondid_u_mean.
Structure: Sub-element of queryTransformation.
any value
queryAlternative spelling of the search term.
Structure: Sub-element of queryTransformation.
any value
docsetElement to contain one or several sub-elements.
Structure: Sub-element of result.
no value
total_timeTime used by the search engine to retrieve results.
Structure: Sub-element of docset.
any number
totalhitsNumber of results found by search.
Structure: Sub-element of docset.
any number
docElement to contain one or several sub-elements.
Structure: Sub-element of docset.
no value
localDefines if search was done locally or remotely.
Structure: Sub-element of doc.
"true" or "false"
Default: true
pnx:PrimoNMBibElement to contain one or several sub-elements.
Default: true
FOLDERfolder name and code.
Structure: Sub-element of doc.
no value
recordDetails 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>
                &lt;t>1&lt;/t>
                <c1>a45002206</c1>
                <c3>impactofthewaroncommninredwing</c3>
                <c4>1945</c4>
                ...
              </dedup>
              <frbr>
                &lt;t>1&lt;/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&amp;ctx_enc=info:ofi/enc:UTF-8&amp;ctx_tim=2010-12-20T10%3A49%3A17IST&amp;url_ver=Z39.88-2004&amp;url_ctx_fmt=infofi/fmt:kev:mtx:ctx&amp;rfr_id=info:sid/primo.exlibrisgroup.com:primo3-Journal-primo_aleph&amp;rft_val_fmt=info:ofi/fmt:kev:mtx:book&amp;rft.genre=book&amp;rft.atitle=&amp;rft.jtitle=&amp;rft.btitle=The%20impact%20of%20the%20war%20on%20community%20leadership%20and%20opinion%20in%20Red%20Wing,&amp;rft.aulast=Chapin&amp;rft.auinit=&amp;rft.auinit1=&amp;rft.auinitm=&amp;rft.ausuffix=&amp;rft.au=Chapin,%20F.%20Stuart%20(Francis%20Stuart),%201888-&amp;rft.aucorp=&amp;rft.volume=&amp;rft.issue=&amp;rft.part=&amp;rft.quarter=&amp;rft.ssn=&amp;rft.spage=&amp;rft.epage=&amp;rft.pages=&amp;rft.artnum=&amp;rft.issn=&amp;rft.eissn=&amp;rft.isbn=&amp;rft.sici=&amp;rft.coden=&amp;rft_id=info:doi/&amp;rft.object_id=&amp;rft_dat=&lt;primo_aleph>000250494&lt;/primo_aleph>&amp;rft.eisbn=&amp;rft_id=info:oai/" GetIt1="http://qa-server03.corp.exlibrisgroup.com:8991/F?func=item-global&amp;doc_library=USM01&amp;local_base=USM01&amp;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>