fullViewRequest

NAVIGATE CONTENT
Ex Libris Developer Network Primo Documentation Primo REST APIs Web Services – Legacy SOAP (Web Services) Search fullViewRequest

General Purpose

Provides the full view of a specific item

WSDL

The WSDL file is located under the following URL:
:/PrimoWebServices/services/searcher?wsdl

Input Parameters

ElementDescriptionValueDefaultStructure
fullViewRequestRoot element of the XML treeno valueroot element
docIdRecordid from PNX tablestringsubelement of FullViewRequest
getDeliveryIf set to true, this parameter requests GetIt data.false or truesubelement of FullViewRequest
PrimoSearchRequestElement to hold several subelements (see structure)no valuesubelement of FullViewRequest
QueryTermsElement to hold several subelements (see structure)no valuesubelemen of PrimoSearchRequest
BoolOpeatordefines the relationship between the different QueryTerm“AND” or “OR”ANDsubelement of QueryTerms
QueryTermElement to hold several subelements (see structure)no valuesubelement of QueryTerms
IndexFieldWhere to search“any” or “title” or “author” or “subject” or “keyword”subelement of QueryTerm
PrecisionOperatorPhrase or key word search“exact” or “contains’subelement of QueryTerm
ValueSearch Query Stringany valuesubelement of QueryTerm
StartIndexstart index of retrieved result list“1” to “n”subelement of PrimoSearchRequest
BulkSizebulk size“10” or “20” or “30”subelement of PrimoSearchRequest
DidUMeanEnabledindication of did you mean“true” or “false”FALSEsubelement of PrimoSearchRequest
HighlightingEnabledindication whether highlights by server is required“true” or “false”FALSEsubelement of PrimoSearchRequest
GetMoreApplicable only for remote search. It simulates the “Get More” functionality.“true” or “false”FALSEsubelement of PrimoSearchRequest
LanguagesElement to contain one or several subelements (see structure)no valuesubelement of PrimoSearchRequest
LanguageHints input languages to search engine for language recognition“eng” or “fre” or “ger” (Code for the representation of name of language conform to ISO-639)subelement of Languages
SortByListElement to contain one or several subelements (see structure)no valuesubelement of PrimoSearchRequest
SortFieldFields to sort results byIndex field names available constants list : “title” or “creator” or “lang” or “cdate”subelement of SortByList
DisplayFieldsElement to contain one or several subelements (see structure)no valuesubelement of PrimoSearchRequest
DisplayFieldUsed by the search engine highlighterPNX field names from the Display sectionsubelement of DisplayFields
LocationsElement to contain one or several subelements (see structure)no valuesubelement of PrimoSearchRequest
Locationsearch scopeThe Location subelement contains the type and value attributes.

For Primo Central only:
<uic:Location type=\”adaptor\” value=\”primo_central_multiple_fe\” />

For blended scopes:
<uic:Location type=\”local\” value=\”scope:(scope_name)\”/>\n
<uic:Location type=\”remote\” value=\”quickset_name\”/>\n
<uic:Location type=\”adaptor\” value=\”primo_central_multiple_fe\” />

subelement of Locations
typeattribute of Location“local” or “remote”attribute of Location
valueattribute of Location1. local: specfies the scope restriction (search constraint). 2. remote: quickSet nameattribute of Location

Output Parameters

ElementDescriptionValueDefaultStructure
segmentsRoot element of the XML treeno valueroot element
jagrootElement to contain one or several subelements (see structure)no valuesubelement of segments
resultElement to contain one or several subelements (see structure)no valuesubelement of jagroot
querytransformationsElement to contain one or several subelements (see structure)no valuesubelement of result
querytransformationElement to contain one or several subelements (see structure)no valuesubelement of querytransformations
actiondid_u_meanany valuesubelement of querytransformation
queryalternative spelling of the search termany valuesubelement of querytransformation
docsetElement to contain one or several subelements (see structure)no valuesubelement of result
total_timetime used by the search engine to retrieve resultsany numbersubelement of docset
totalhitsnumber of results found by searchany numbersubelement of docset
docElement to contain one or several subelements (see structure)no valuesubelement of docset
localdefines if search was done locally or remotely“true” or “false”truesubelement of doc
pnx:PrimoNMBibElement to contain one or several subelements (see structure)no valuesubelement of doc
recordDetails about how the internal structure of a PNX can be found in the technical guide

Input Example

<fullViewRequest xmlns="http://www.exlibris.com/primo/xsd/wsRequest" xmlns:req="http//www.exlibris.com/primo/xsd/search/request">
  <req:PrimoSearchRequest>
    <req:QueryTerms>
      <req:BoolOpeator>AND</req:BoolOpeator>
      <req:QueryTerm>
        <req:IndexField>any</req:IndexField>
        <req:PrecisionOperator>contains</req:PrecisionOperator>
      </req:QueryTerm>
    </req:QueryTerms>
    <req:StartIndex>0</req:StartIndex>
    <req:BulkSize>10</req:BulkSize>
    <req:DidUMeanEnabled>false</req:DidUMeanEnabled>
    <req:FacetList/>
  </req:PrimoSearchRequest>
  <docId>White_Shore_Voyager81686</docId>
  <getDelivery>true</getDelivery>
  <ip>127.0.0.1</ip>
  <institution>PRIMO</institution>
  <onCampus>false</onCampus>
</fullViewRequest>

Output Example

<SEGMENTS xmlns="http://www.exlibrisgroup.com/xsd/jaguar/search">
  <JAGROOT>
    <RESULT>
      <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>
                ...
              </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>
                ...
              </links>
              <search>
                <title>Harry Potter and the deathly hallows /</title>
                <subject>Potter, Harry (Fictitious character) Fiction.</subject>
                ...
              </search>
              <sort>
                <title>Harry Potter and the deathly hallows /</title>
                <creationdate>2007</creationdate>
                ...
              </sort>
              <facets>
                <language>eng</language>
                <creationdate>2007</creationdate>
                ...
              </facets>
              <dedup>
                <f7>harry potter and the deathly hallows</f7>
                <f8>nyu</f8>
               ...
              </dedup>
              <frbr>
                &lt;t>1&lt;/t>
                <k1>$$Krowling j k$$AA</k1>
              </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&amp;ctx_enc=info:ofi/enc:UTF-8&amp;ctx_tim=2011-06-10T17%3A28%3A55IST&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-White_Shore_Voyager&amp;rft_val_fmt=info:ofi/fmt:kev:mtx:book&amp;rft.genre=book&...../>
          <sear:GETIT GetIt2="" GetIt1="OVP" deliveryCategory="Physical Item"/>
          <sear:LIBRARIES>
            <sear:LIBRARY>
              <sear:library>MAIN</sear:library>
              ...
            </sear:LIBRARY>
          </sear:LIBRARIES>
          <sear:LINKS>
            <sear:openurl><![CDATA[></sear:openurl>
            ...
          </sear:LINKS>
        </sear:DOC>
      </DOCSET>
    </RESULT>
  </JAGROOT>
</SEGMENTS>