Ready to Learn?Ex Libris products all provide open APIs

General Purpose

Search for SIPs or IEs based on the SRU protocol. Returns matching SIP or IE metadata via SRU protocol as one or more Dublic Core records, enriched with a SIP ID or an IE PID as a dc:identifier. IEs are also enriched with delivery deep links. 

Note: SIP search is supported as of Rosetta v5.3.
 

Input Parameters

ParameterDescriptionValue
server nameThe server name or the IP addressstring
port numberThe port number that the server is listening onnumber
versionThe SRU version - Should be '1.2'string
operationThe specific SRU operation - Should be 'searchRetrieve'string
queryThe IE field that the search is based on (see examples below)string
maximumRecordsThe maximum number of records returned per response (optional)number
recordSchemaThe requested metadata format (optional, currently dc only)string
startRecordThe start of the range of the result set records (optional, default=1)number
sortBySort results by an IE indexed field + sort.descending /sort.ascending (optional)string

 

Input URL Syntax

SRU request based on an indexed field:
 
https:// <Rosetta delivery load balancer host>:<Rosetta delivery load balancer port>/search/operational/sru?version=1.2&operation=searchRetrieve&query=<Field XPath>=<Value>&maximumRecords=5&recordSchema=dc
 
https:// <Rosetta delivery load balancer host>:<Rosetta delivery load balancer port>/search/permanent/sru?version=1.2&operation=searchRetrieve&query=<Field XPath>=<Value>&maximumRecords=5&recordSchema=dc
 
In order to get all the Field XPath values that can be searched through SRU, users can use the following URL:
Note: For purposes of backward compatibility, the base URL http://rosetta.exlibrisgroup.com:1801/delivery/sru is also supported for IE search. Users should prefer the URL above.

Limitations

  • Operator between search fields must by 'and' (not 'or' etc.).
  • Operator within a search field must be = for matching by keyword, or == for matching a phrase (=="" for 'is empty'). Other operators (!=, <, etc.) are not supported.
  • Date format in date fields must be YYYY-MM-DD.

 

Input Example

IE Delivery via SRU based on File Extension sorted, maximum records:

http://rosetta.exlibrisgroup.com:1801/search/permanent/sru?version=1.2&operation=searchRetrieve&query=FILE.generalFileCharacteristics.fileExtension=jpg%20sortBy%20IE.dc.title/sort.descending&maximumRecords=5
 

IE Delivery via SRU based on Access Rights Policy and dc:creator:

http://rosetta.exlibrisgroup.com:1801/search/permanent/sru?version=1.2&operation=searchRetrieve&query=IE.accessRightsPolicy.policyId=AR_EVERYONE+IE.dc.creator=%22van%20gogh%22
 
 

SIP Delivery via SRU based on SIP ID

http://rosetta.exlibrisgroup.com:1801/search/operational/sru?version=1.2&operation=searchRetrieve&query=SIP.pid=2

 

IE Delivery via SRU based on date (dcterms:created):

http://rosetta.exlibrisgroup.com:1801/search/permanent/sru?version=1.2&operation=searchRetrieve&query=IE.dcterms.created=2010-10-05
 

Output Example

Multiple IEs

 
<?xml version="1.0" encoding="UTF-8"?><searchRetrieveResponse xmlns=">

  <version>1.2</version>

  <numberOfRecords>15</numberOfRecords>

  <records>

    <record>

      <recordSchema>info:srw/schema/1/dc-v1.1</recordSchema>

      <recordPacking>xml</recordPacking>

      <recordData>

        <dc:record xmlns:dc=" xmlns:xsi=" xmlns:mets=" xmlns:dv=" xmlns:xlin=" xmlns:mix=" xmlns:mods=" xmlns:dcterms=">

          <dc:title>Jubel-Kalender zur Erinnerung an die Völkerschlacht bei Leipzig vom 16. - 19. October A. D. 1813</dc:title>
          <dc:type>text</dc:type>

          <dc:publisher>Weber</dc:publisher>

          <dc:date>1863</dc:date>

          <dc:publisher>universitäts- und Landesbibliothek</dc:publisher>

          <dc:rights>AR_EVERYONE</dc:rights>

          <dc:identifier xsi:type="PID">IE21737</dc:identifier>

          <dc:identifier xsi:type="stream"></dc:identifier>

          <dc:identifier xsi:type="thumbnail"></dc:identifier>

        </dc:record>

      </recordData>

      <recordPosition>1</recordPosition>

    </record>

    <record>

      <recordSchema>info:srw/schema/1/dc-v1.1</recordSchema>

      <recordPacking>xml</recordPacking>

      <recordData>

        <dc:record xmlns:dc=" xmlns:xsi=" xmlns:mets=" xmlns:dv=" xmlns:xlin=" xmlns:mix=" xmlns:mods=" xmlns:dcterms=">

          <dc:title>Katechismus für den teutschen Kriegs- und Wehrmann, worin gelehret wird, wie ein christlicher Wehrmann seyn und mit Gott in den Streit gehen soll</dc:title>

          <dc:type>text</dc:type>

          <dc:date>1813</dc:date>

          <dc:publisher>universitäts- und Landesbibliothek</dc:publisher>

          <dc:rights>AR_EVERYONE</dc:rights>

          <dc:identifier xsi:type="PID">IE22978</dc:identifier>

          <dc:identifier xsi:type="stream"></dc:identifier>

          <dc:identifier xsi:type="thumbnail"></dc:identifier>

        </dc:record>

      </recordData>

      <recordPosition>2</recordPosition>

    </record>

  </records>

</searchRetrieveResponse>
 

Single IE

 
<?xml version="1.0" encoding="UTF-8"?>

<searchRetrieveResponse xmlns="http://www.loc.gov/zing/srw/">

<version>1.2</version>

<numberOfRecords>1</numberOfRecords>

<records>

<record>

<recordSchema>info:srw/schema/1/dc-v1.1</recordSchema>

<recordPacking>xml</recordPacking>

<recordData>

<dc:record xmlns:dc=" xmlns:xsi=" xmlns:mets=" xmlns:xlin=" xmlns:mods=" xmlns:dcterms=">

<dc:title>cell line "M1", combination of antibody stainings no 2</dc:title>

<dc:identifier>M1_Kombi2</dc:identifier>

<dc:creator>admin</dc:creator>

<dc:format>Olympus Image Format</dc:format>

<dcterms:created>2012-10-29</dcterms:created>

<dcterms:isPartOf>CAi Collections/Wintersemester 2012/IIF/Gruppe 1</dcterms:isPartOf>

<dc:rights>AR_EVERYONE</dc:rights>

<dc:identifier xsi:type="PID">IE23618</dc:identifier>

<dc:identifier xsi:type="stream"/>

<dc:identifier xsi:type="thumbnail"/>

</dc:record>

</recordData>

<recordPosition>1</recordPosition>

</record>

</records>

</searchRetrieveResponse>