HoldingsIQ Documentation Title

 

 

The HoldingsIQ service retrieves vendor, package and title related information in JSON format. The service automates the managing of holdings data from different sources.

 

 

 

 

Advanced Search Type

The full advanced search type is supported by the GET /{custid}/titles endpoint.  The searches supported by the full advanced search type are below:

  • Phrase Support
  • Boolean Support (AND, OR, NOT)
  • Wild Character Support

The GET /{custid}/packages and GET /{custid}/vendors/{vendorid}/packages endpoints support only Boolean searches when using the advanced search type.

Set the search type to advanced to use phrase, boolean or wild character advanced searching.

To Use the Advanced Search Type (example):

Request

GET https://sandbox.ebsco.io/rm/rmaccounts/CUSTID/titles?search=teen&searchfield=titlename&selection=0&resourcetype=0&orderby=0&count=100&offset=1&searchtype=advanced

 

Advanced Search Type Phrase Support

Phrase searching is supported by the GET /{custid}/titles endpoint. When you would like to use search terms in the order in which they appear, phrase searching is needed. Use double quotes around your search terms and set the searchtype to advanced to use phrase searching.

To Use Phrase Searching (example):

Request

GET https://sandbox.ebsco.io/rm/rmaccounts/CUSTID/titles?search=”Teen Ink: Our Voices, Our Visions”&searchfield=titlename&selection=0&resourcetype=0&orderby=0&count=100&offset=1&searchtype=advanced

 

Advanced Search Type Boolean Support

To make your search more precise, boolean operators for your search terms are supported by the GET /{custid}/titles, GET /{custid}/packages, and GET /{custid}/vendors/{vendorid}/packages endpoints. You can use AND, OR and/or NOT to link your search words together. By narrowing or broadening your search, the boolean operators help you retrieve the information that you need quickly.

 

AND

OR NOT
Each result contains all of the search terms. Each result contains at least one search term. Results do not contain the specified term(s).

 

Using the AND Operator

The AND operator combines search terms so that each search result contains all of the terms. For example, use search=sleep AND walking to find results that refer to both sleep and walking.

Example Request

GET https://sandbox.ebsco.io/rm/rmaccounts/CUSTID/titles?search=sleep AND walking&searchfield=titlename&selection=0&resourcetype=0&orderby=0&count=100&offset=1&searchtype=advanced

Using the OR Operator

The OR operator combines search terms so that each search result contains at least one of the terms. For example, use search=sleep OR waking to find results that reference the terms sleep or the term waking.

Example Request

GET https://sandbox.ebsco.io/rm/rmaccounts/CUSTID/titles?search=sleep OR waking&searchfield=titlename&selection=0&resourcetype=0&orderby=0&count=100&offset=1&searchtype=advanced

Using the NOT Operator

The NOT operator excludes terms so that each search result does not contain any of the terms that follow it. For example, use search=walking NOT waking to find results that contain the term walking but not the term waking.

Example Request

GET https://sandbox.ebsco.io/rm/rmaccounts/CUSTID/titles?search=walking NOT waking&searchfield=titlename&selection=0&resourcetype=0&orderby=0&count=100&offset=1&searchtype=advanced

Performing a Generalized Search

You can combine many terms in a search with operators. For example, use search=dog OR cat AND show OR parade to retrieve everything on dog or cat shows AS WELL AS everything on parades whether or not the articles refer to dogs or cats.

Example Request

GET https://sandbox.ebsco.io/rm/rmaccounts/CUSTID/titles?search=dog OR cat AND show OR parade&searchfield=titlename&selection=0&resourcetype=0&orderby=0&count=100&offset=1&searchtype=advanced

Performing a Focused Search

You can enclose search terms and their operators in parentheses to specify the order in which they are interpreted. Information within parentheses is read first, and then information outside parentheses is read next. For example, use search= (dog OR cat) AND (show OR parade) with parentheses to control your query to only find articles about shows or parades that reference dogs or cats.

Example Request

GET https://sandbox.ebsco.io/rm/rmaccounts/CUSTID/titles?search=(dog OR cat) AND (show OR parade)&searchfield=titlename&selection=0&resourcetype=0&orderby=0&count=100&offset=1&searchtype=advanced

 

Advanced Search Type Wildcard Support

Wildcard character searching is supported by the GET /{custid}/titles endpoint. Use the wildcard asterisk (*) to create searches where there are unknown characters, multiple spellings or various endings. None of the wildcards can be used as the first character in a search term. To use the asterisk (*) wildcard, enter the root of a search term and replace the ending with an *. For example, type comput* to find the words computer or computing.

Example Request

GET https://sandbox.ebsco.io/rm/rmaccounts/CUSTID/titles?search=comput*&searchfield=titlename&selection=0&resourcetype=0&orderby=0&count=100&offset=1&searchtype=advanced