Get List of Packages

get deprecated

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

This operation allows you to search for packages and returns a list of packages from EPKB. The list is not limited to a single vendor ID. The response will reflect the context of the EBSCO customer ID included in the request. When searching for packages without a search parameter, the sort options will be by package name. When the search parameter is not null, then 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. This endpoint has been deprecated. Please use this endpoint instead: /v2/{custid}/lists/

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

custid

string

required

EBSCO Customer ID

Query Params

string

required

Keyword search that is applied to limit the results to packages from the vendor that have the search term in the package name. 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!.

searchtype

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:

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 not selected or 3 for ordered through EBSCO. When you filter by all(0), the total results count takes selected and not selected into consideration.

Allowed:

contenttype

string

enum

Limits the results 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.

orderby

string

enum

required

Valid values are packagename and relevance. 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.

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 packages and the total packages found.

defaultUnexpected Error