Ready to Learn?Ex Libris products all provide open APIs

Getit

General Purpose

The getit request returns the GetIt link for a specific item.

Input Parameters

ParameterDescriptionValue
docIdRecord id from the PNX table.
institutionInstitution code.
isLoggedInIndicates if the user logged in."true" or "false"
onCampusIndicates if the user is on campus."true" or "false"
groupName of the user group.string
pdsHandleThe handle used for PDS.string

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
GETITElement to contain one or several sub-elements.
Structure: Sub-element of doc.
no value
GetIt1Primary GetIt link.
Structure: Sub-element of doc.
any value
GetIt2Secondary GetIt link.
Structure: Sub-element of doc.
any value
pnx:PrimoNMBibElement to contain one or several sub-elements.
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/getit?institution=PRIMO&docId=demo_voyager968394&isLoggedIn=true&onCampus=true&group=GUEST&pdsHandle=PRMSO

Output Example

  <JAGROOT>
    <RESULT>
      <DOCSET TOTALHITS="1">
          <PrimoNMBib>
            <record>
              <control>
                <sourcerecordid>000000030</sourcerecordid>
                <sourceid>Blue_Bay_Aleph</sourceid>
                <recordid>Blue_Bay_Aleph000000030</recordid>
                <originalsourceid>PRM01</originalsourceid>
                <ilsapiid>PRM01000000030</ilsapiid>
                <sourceformat>MARC21</sourceformat>
                <sourcesystem>Aleph</sourcesystem>
              </control>
              <display>
                <type>book</type>
                <title>Adhesion and the formulation of adhesives</title>
                <creator>William Charles Wake</creator>   
                 ...       
                <source>Blue_Bay_Aleph</source>
                <availlibrary>$$IVOLCANO$$LNFOR$$1General collection$$2(TP968 .W34 1982 )$$Savailable$$32$$40$$5N$$60$$XPRM50$$YNFOR$$ZGEN</availlibrary>
                <availinstitution>$$IVOLCANO$$Savailable</availinstitution>
                <availpnx>available</availpnx>
              </display>
              <links>
                <openurl>$$Topenurl_journal</openurl>
                ...
              </links>
              <search>
                <creatorcontrib>William Charles Wake</creatorcontrib>
                <title>Adhesion and the formulation of adhesives /</title>
                <subject>Adhesives.</subject>
                 ...
                <scope>VOLCANO</scope>
              </search>
              <sort>
                <title>Adhesion and the formulation of adhesives /</title>
                <creationdate>1982</creationdate>
                <author>Wake, William Charles.</author>
              </sort>
              <facets>
                <language>eng</language>
                ...
              </facets>
              <dedup>
              ...
              </dedup>
              <frbr>
              ...
              </frbr>
              <delivery>
                <institution>VOLCANO</institution>
                <delcategory>Physical Item</delcategory>
              </delivery>
              <enrichment>
                <classificationlcc>TP968</classificationlcc>
              </enrichment>
              <ranking>
                <booster1>1</booster1>
                <booster2>1</booster2>
              </ranking>
              <addata>
              ...
              </addata>
            </record>
          </PrimoNMBib>
          <sear:LIBRARIES>
            <sear:LIBRARY>
              <sear:institution>VOLCANO</sear:institution>
              <sear:library>NFOR</sear:library>
              <sear:status>available</sear:status>
              <sear:collection>General collection</sear:collection>
              <sear:callNumber>(TP968 .W34 1982 )</sear:callNumber>
              <sear:url></sear:url>
            </sear:LIBRARY>
          </sear:LIBRARIES>
          <sear:LINKS>
            <sear:openurl>
              <![CDATA[
  ]]>
            </sear:openurl>
            <sear:backlink></sear:backlink>
            <sear:thumbnail></sear:thumbnail>
            <sear:thumbnail></sear:thumbnail>
            <sear:thumbnail></sear:thumbnail>
            <sear:linktotoc></sear:linktotoc>
            <sear:linktoabstract></sear:linktoabstract>
            <sear:openurlfulltext>
              <![CDATA[
  ]]>
            </sear:openurlfulltext>
            <sear:linktoholdings></sear:linktoholdings>
            <sear:linktouc></sear:linktouc>
            <sear:linktouc></sear:linktouc>
          </sear:LINKS>
        </sear:DOC>
      </DOCSET>
    </RESULT>
  </JAGROOT>
</SEGMENTS>