Get List of Titles Regardless of Package

get

https://sandbox.ebsco.io/rm/rmaccounts/v2/{custid}/titles

This operation allows you to search and retrieve a list of titles from EPKB regardless of the package(s) that the titles are a part of. The response will reflect the context of the EBSCO customer ID included in the request.

Please Note: You will need an API key to gain access to the API through our interactive documentation. If you require an API key, please contact EBSCO customer support.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

custid

string

required

EBSCO Customer ID

Query Params

string

required

Search Term. Keyword search that is applied to limit the results to titles that have the search term in the search field. Special characters in the search term need to be URL encoded. Ex: A&G encodes to A%26G. The Swagger Explorer performs the search parameter encoding for the Try it out!.

searchfield

string

enum

required

Field to search. Both integer and string are supported. Valid values are titlename, publisher, isxn, subject and zdbid. It is also valid to use 0 for title name, 1 for publisher, 2 for isxn, 3 for subject or 4 for zdbid.

Allowed:

selection

string

enum

Limits the results. Valid values are all, selected, notselected and orderedthroughebsco. It is also valid to use 0 for all, 1 for selected, 2 for notselected, or 3 for ordered through EBSCO. When you filter by all(0), the total results count takes selected and not selected into consideration.

Allowed:

resourcetype

string

enum

Type of resource. Valid values are all, journal, newsletter, report, proceedings, website, newspaper, unspecified, book, bookseries, database, thesisdissertation, streamingaudio, streamingvideo, and audiobook. It is also valid to use 0 for all, 1 for journal, 2 for newsletter, 3 for report, 4 for proceedings, 5 for website, 6 for newspaper, 7 for unspecified, 8 for book, 9 for book series, 10 for database, 11 for thesis dissertation, 12 for streaming audio, 13 for streaming video, or 14 for audio book.

searchtype

string

enum

Type of search. Search types are any, contains, exactmatch, beginswith, proximity, exactphrase and advanced. It is also valid to use 0 for any, 1 for contains, 2 for exactmatch, 3 for beginswith, 4 for proximity, 5 for exactphrase or 6 for advanced. searchtype is an optional parameter and defaults to contains if not provided. For more information on the search types, see Using Search Types.

Allowed:

packageidfilter

array of strings

A comma-separated list of package ID(s). Limits the results by package ID(s). The packageidfilter is an optional parameter.

packageidfilter

orderby

string

enum

required

Valid values are relevance or titlename. Default is relevance.

Allowed:

count

integer

enum

required

The maximum number of results to return in the response.

Allowed:

offset

integer

required

Page Offset. Starts at 1.

packagefreeaccess

string

enum

Limits the results based on Package Free Access. The filter options are (true, false, all), and the default is all.

Allowed:

subjects

array of strings

Types of subjects to be returned. By default returns tli and bisac. Valid values are: bisac, tli, libraryofcongress and medical.

subjects

consortia

array of strings

Filters title search by given consortia values. If multiple consortia names are given, documents containing any of the given consortias will be returned. Accepts consortia names or no_consortia.

consortia

Headers

x-api-key

string

required

Unique code assigned by EBSCO to grant you access to this API. The API key needs to be a header parameter for every operation in order to access this API. You will need an API key to use the interactive documentation. If you require an API key, please contact EBSCO customer support.

Responses

200List of titles that are part of a specified package.

defaultUnexpected Error