SearchRequest

General Purpose

WSDL

Request Example

The request expects 1 parmeter only, which is searchRequestStr.
This parameter is of type string.
The web service is expecting this parameter to hold an XML "Primo Search Request".

View the "Primo Search Request" XSD here.
SOAP envelope request and the place holder for your "Primo search request":

<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:api="http://api.ws.primo.exlibris.com">
    <soapenv:Header/>
    <soapenv:Body>
        <api:searchBrief soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
            <searchRequestStr xsi:type="soapenc:string" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">
                Your Primo Search Request HERE
            </searchRequestStr>
        </api:searchBrief>
    </soapenv:Body>
</soapenv:Envelope>

Primo Search Request example:

<searchRequest xmlns="http://www.exlibris.com/primo/xsd/wsRequest"  xmlns:uic="http://www.exlibris.com/primo/xsd/primoview/uicomponents">

    <PrimoSearchRequest xmlns="http://www.exlibris.com/primo/xsd/search/request">
        <QueryTerms>
            <BoolOpeator>AND</BoolOpeator>
            <QueryTerm>
                <IndexField>any</IndexField>       
                <PrecisionOperator>contains</PrecisionOperator>
                <Value>book</Value>
            </QueryTerm>
        </QueryTerms>
        <StartIndex>1</StartIndex>
        <BulkSize>10</BulkSize>
        <DidUMeanEnabled>true</DidUMeanEnabled>
        <HighlightingEnabled>true</HighlightingEnabled>
        <Languages><Language>eng</Language></Languages>
        <SortByList>
            <SortField>stitle</SortField>
        </SortByList>
        <DisplayFields>title</DisplayFields>
        <Locations>
            <uic:Location type="local" value=""/>
        </Locations>
        <InstBoost>true</InstBoost>
    </PrimoSearchRequest>
    <ip>127.0.0.1</ip>
    <group>GUEST</group>
    <onCampus>false</onCampus>
    <isLoggedIn>true</isLoggedIn>
    <institution>%s</institution>
</searchRequest>

Combined final request example:

<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:api="http://api.ws.primo.exlibris.com">
    <soapenv:Header/>
    <soapenv:Body>
        <api:searchBrief soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
            <searchRequestStr xsi:type="soapenc:string" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">

                    <searchRequest xmlns="http://www.exlibris.com/primo/xsd/wsRequest"  xmlns:uic="http://www.exlibris.com/primo/xsd/primoview/uicomponents">

                         <PrimoSearchRequest xmlns="http://www.exlibris.com/primo/xsd/search/request">
                               <QueryTerms>
                               ...
                        </PrimoSearchRequest>
                 </searchRequest>
            </searchRequestStr>
        </api:searchBrief>
    </soapenv:Body>
</soapenv:Envelope>

Combined final request (encoded) example

The searchRequestStr is of type string.

This means you need to make sure the searchRequest you are placing in it, is encoded as a string.

You can do this by using the CDATA tag.

When using a SOAP client (such as soapUI which is a desktop client) you will need to encode the searchRequest so the combined request might look like:

<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:api="http://api.ws.primo.exlibris.com">
    <soapenv:Header/>
    <soapenv:Body>
        <api:searchBrief soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
            <searchRequestStr xsi:type="soapenc:string" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">

                    <![CDATA[

                 <searchRequest xmlns="http://www.exlibris.com/primo/xsd/wsRequest"  xmlns:uic="http://www.exlibris.com/primo/xsd/primoview/uicomponents">

                         <PrimoSearchRequest xmlns="http://www.exlibris.com/primo/xsd/search/request">
                               <QueryTerms>
                               ...
                        </PrimoSearchRequest>
                 </searchRequest>

                  ]]>
            </searchRequestStr>
        </api:searchBrief>
    </soapenv:Body>
</soapenv:Envelope>

The following are the parameters in the “Primo Search Request”:

The request is mainly combined from two “parts”:

1. searchRequest
2. PrimoSearchRequest (resides under the searchRequest)

The structure of the searchRequest (XSD):

<xs:complexType name="SearchRequest">
           <xs:sequence>
               <xs:element ref="psr:PrimoSearchRequest"/>
               <xs:element name="ip"  type="xs:string"  maxOccurs="1"/>
               <xs:element name="institution"  type="xs:string"  maxOccurs="1"/>
               <xs:element name="group"  type="xs:string"  maxOccurs="1"/>
               <xs:element name="onCampus"  type="xs:boolean" maxOccurs="1"/>
               <xs:element name="isLoggedIn" type="xs:boolean" maxOccurs="1" minOccurs="0"/>
               <xs:element name="pdsHandle"  type="xs:string" maxOccurs="1" minOccurs="0"/>
           </xs:sequence>

</xs:complexType>

The structure of the PrimoSearchRequest (XSD):

<xs:element name="PrimoSearchRequest">
    <xs:complexType>
        <xs:sequence>
            <xs:element ref="RequestParams" minOccurs="0" maxOccurs="1"/>
            <xs:element ref="QueryTerms" />
            <xs:element name="StartIndex" type="xs:int"    default="0">
            <xs:element name="BulkSize" type="xs:int" default="10">
            <xs:element name="DidUMeanEnabled" type="xs:boolean" default="false">
            <xs:element name="HighlightingEnabled" type="xs:boolean" default="false" minOccurs="0" maxOccurs="1">    
            <xs:element name="GetMore" type="xs:int" default="0" minOccurs="0" maxOccurs="1">
            <xs:element ref="Languages" minOccurs="0" maxOccurs="1">
            <xs:element ref="SortByList" minOccurs="0" maxOccurs="1">
            <xs:element name="DisplayFields" type="xs:string" maxOccurs="unbounded" minOccurs="0">
            <xs:element ref="Locations" minOccurs="0" maxOccurs="1">
            <xs:element name="InstBoost" type="xs:boolean" maxOccurs="1" minOccurs="0">
            <xs:element ref="PersonalizedRankingParams" minOccurs="0" maxOccurs="1"/>
        </xs:sequence>
    </xs:complexType>
</xs:element>