Get List of Packages for a Vendor

This operation allows you to retrieve a list of packages from EPKB for a vendor including customer context.

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. This endpoint has been deprecated. Please use this endpoint instead: /v2/{custid}/vendors/{vendorid}/lists

Path Params
integer
required

Vendor ID

string
required

EBSCO Customer ID

Query Params
string

Keyword search applied to limit the package list results. The search term is contained in the package name. When searching for packages without a search parameter, the sort options will be by packagename. 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
enum

Type of search to be performed. Valid values are exactphrase and advanced. It is also valid to use 1 for exactphrase or 2 for advanced. For more information on the search types, see Using Search Types.

Allowed:
string
enum

Limits the result set. 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:
string
enum

Limit by type of package content. Both integer and string are supported. Valid values are all, aggregatedfulltext, abstractandindex, ebook, ejournal, print, unknown, onlinereference, streamingmedia or mixedcontent. It is also valid to use 0 for all, 1 for aggregated full text, 2 for abstract and index, 3 for ebook, 4 for ejournal, 5 for print, 6 for unknown, 7 for online reference, 8 for streaming media or 9 for mixed content.

string
enum
required

Valid values are relevance or packagename. Default is relevance.

Allowed:
integer
enum
required

The maximum number of results to return in the response.

Allowed:
integer
required

Page Offset. Starts at 1.

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
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json