URI Syntax

Formulate the URI Syntax

The basic URI structure is as follows:

http://ulrichsweb.serialssolutions.com/api/<SEARCHAPI_KEY>/search?<SEARCH_QUERY>

where <SEARCHAPI_KEY> is the unique, 10-digit Key for your institution, and <SEARCH_QUERY> is in the following form:

query=<FIELD>:<TERM>&filterQuery=<FIELD>:<TERM>&sortIndex=<FIELD>&sortOrder=<ORDER>&start=<NUM>&rows=<NUM>

The first section of <SEARCH_QUERY> is required:

query=<FIELD>:<TERM>
<FIELD> can be any of the search fields in List of Available Fields for Query and Output.
<TERM> is the term (value or text) you are searching for in the <FIELD>.

The rest of <SEARCH_QUERY> is optional:

• filterQuery=<FIELD>:<TERM> — The field to filter by. <FIELD> can be any of the filter fields in List of Available Fields for Query and Output.
• sortIndex=<FIELD> — The field to sort by. <FIELD> can be any of the search fields in List of Available Fields for Query and Output.
• sortOrder=<ORDER> — The order in which the sortIndex is sorted. <ORDER> can be “asc” or “desc” (ascending or descending).
• start=<NUM> — The record number at the start of the result set (default: 0). <NUM> must be a positive integer.

• rows=<NUM> — The number of records to be returned (default: 10, max: 50). <NUM> must be an integer between 1 and 50.

Example URLs:

1. Get first 10 records where title contains “garden” and SearchAPIKey is: WYYIWQF9EF:

http://ulrichsweb.serialssolutions.com/api/WYYIWQF9EF/search?query=title:garden

2. Get next 10 records:

http://ulrichsweb.serialssolutions.com/api/WYYIWQF9EF/search?query=title:garden&start=10

3. Get first 50 records:

http://ulrichsweb.serialssolutions.com/api/WYYIWQF9EF/search?query=title:garden&rows=50

4. Get first 10 records, sorted in descending order by title:

http://ulrichsweb.serialssolutions.com/api/WYYIWQF9EF/search?query=title:garden&sortIndex=title&sortOrder=desc

5. Get first 10 records where title contains “populism” and results are filtered to refereed titles only:

http://ulrichsweb.serialssolutions.com/api/WYYIWQF9EF/search?query=title:populism&filterQuery=refereed:true