Ready to Learn?Ex Libris products all provide open APIs

General Purpose

The search/full request displays the full view of the requested item.

 

Input Parameters

ParameterDescriptionValue
docId Record id from PNX table. string 
ip The client IP. string 
institution The institution code of the view. string 
group Name of the user group. string 
onCampus On/off campus. false or true 
query indexField, precisionOperator, value Any value. 
getDelivery If set to true, this parameter requests GetIt data. false or true 
loc The scope value, which contains the following values separated by a comma: type and value. See explanation in the brief Xservice


 

Output Parameters

ElementDescriptionValue
segments Root element of the XML tree. no value 
jagroot Element to contain one or several subelements. 
Structure: Subelement of segments. 
no value 
result Element to contain one or several subelements. 
Structure: Subelement of jagroot. 
no value 
querytransformations Element to contain one or several subelements. 
Structure: Subelement of result. 
no value 
querytransformation Element to contain one or several subelements. 
Structure: Subelement of queryTransformations. 
no value 
action did_u_mean. 
Structure: Subelement of queryTransformation. 
any value 
query Alternative spelling of the search term. 
Structure: Subelement of queryTransformation. 
any value 
docset Element to contain one or several subelements. 
Structure: Subelement of result. 
no value 
total_time Time used by the search engine to retrieve results. 
Structure: Subelement of docset. 
any number 
totalhits Number of results found by search. 
Structure: Subelement of docset. 
any number 
doc Element to contain one or several subelements. 
Structure: Subelement of docset. 
no value 
local Defines if search was done locally or remotely. 
Structure: Subelement of doc. 
"true" or "false" 
Default: true 
pnx:PrimoNMBib Element to contain one or several subelements. 
Structure: Subelement of doc. 
no value 
record Details about how the internal structure of a PNX can be found in the Primo Technical Guide 


 

Input Example

//primo:170X/PrimoWebServices/xservice/search/full?institution=PRIMO&docId=White_Shore_Voyager81686&query=any,contains,&onCampus=&indx=0&bulkSize=10&getDelivery=true


 

Output Example

 
<sear:SEGMENTS xmlns="http://www.exlibrisgroup.com/xsd/jaguar/search">
  <sear:JAGROOT>
    <sear:RESULT>
      <sear:DOCSET TOTALHITS="1">
        <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>81686</sourcerecordid>

                <sourceid>White_Shore_Voyager</sourceid>

                <recordid>White_Shore_Voyager81686</recordid>

                ...

              </control>

              <display>

                <type>book</type>

                <title>Harry Potter and the deathly hallows</title>

                <creator>J. K. Rowling</creator>

                ...

              </display>

              <links>

                <openurl>$$Topenurl_journal</openurl>

                <backlink>$$Tvoyager_backlink$$Ebacklink</backlink>

                <linktorsrc>$$Uhttp://firstsearch.oclc.org/WebZ/DCARead?standardNoType=1&standardNo=9780545010221:srcdbname=worldcat:fromExternal=true&sessionid=0$$Dcover art</linktorsrc>

                ...

              </links>

              <search>

                <creatorcontrib>J. K.  Rowling</creatorcontrib>

                  ...

                <scope>MAIN</scope>

                <scope>White_Shore_Voyager</scope>

                <scope>WHITESHORE</scope>

              </search>

              <sort>

                <title>Harry Potter and the deathly hallows /</title>

                ...

              </sort>

              <facets>

                <language>eng</language>

                <creationdate>2007</creationdate>

                ...

              </facets>

              <dedup>

                <t>1</t>

                <c2>9780545010221;0545010225;9780545029360;0545029368</c2>

                  ...

              </dedup>

              <frbr>

                <t>1</t>

                <k1>$$Krowling j k$$AA</k1>

                <k3>$$Kharry potter and the deathly hallows$$AT</k3>

              </frbr>

              <delivery>

                <institution>WHITESHORE</institution>

                <delcategory>Online Resource</delcategory>

              </delivery>

              <ranking>

                <booster1>1</booster1>

                <booster2>1</booster2>

              </ranking>

              <addata>

                <aulast>Rowling</aulast>

                <aufirst>J. K.</aufirst>

                ...

              </addata>

            </record>

          </PrimoNMBib>

          <sear:GETIT GetIt2="http://1.1.1.1?ctx_ver=Z39.88-2004 ..."/>

          <sear:GETIT GetIt2="" GetIt1="OVP" deliveryCategory="Physical Item"/>

          <sear:LIBRARIES>

            <sear:LIBRARY>

              <sear:institution>WHITESHORE</sear:institution>

              <sear:library>MAIN</sear:library>

             ...

            </sear:LIBRARY>

          </sear:LIBRARIES>

          <sear:LINKS>

            <sear:openurl><![CDATA[></sear:openurl>

            <sear:backlink></sear:backlink>

            ...

          </sear:LINKS>

        </sear:DOC>

      </sear:DOCSET>
    </sear:RESULT>
  </sear:JAGROOT>
</sear:SEGMENTS>