Get Titles that are Part of a Package

This operation allows you to search and retrieve a list of titles from EPKB that are part of a specified package. The response will reflect the context of the EBSCO customer ID included in the request. When searching for titles without a search parameter, the sort options will be by title name. When the search parameter is not null, the default sort is by relevance.

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.

Log in to see full request history
Path Params
integer
required

Vendor ID

integer
required

Package ID

string
required

EBSCO Customer ID

Query Params
string

Keyword search that is applied to limit the results to titles from the package that have the search term in the search field. When searching for titles without a search parameter, the sort options will be by titlename. When the search parameter is not null, then the default sort is by relevance. 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!.

string
required

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

string

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.

string

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.

string
required

Valid values are relevance and titlename. Default is relevance.

integer
required

The maximum number of results to return in the response.

integer
required

Page Offset. Starts at 1.

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
Headers
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

Language
URL
Click Try It! to start a request and see the response here! Or choose an example:
application/json