Get Packages by Package Name

get

https://sandbox.ebsco.io/pf/v1/pfaccount/{profile}/packages

This resource allows you to search for packages and returns a list of packages from EPKB. The list is limited to a single customer ID. The response will reflect the context of the EBSCO customer ID included in the request. Access to PublicationIQ requires a Publication Finder customer profile. A profile password is optional. If a password is supplied, it must be a valid password assigned to the Publication Finder customer profile. If the password is omitted, the request will only be honored if the Publication Finder customer profile allows guest access in the environment where you are making the request. For example, if you would like to make a request to PublicationIQ in the sandbox environment without a password, guest access must be enabled for the Publication Finder customer profile in the sandbox environment. The same is true in the production environment. This documentation uses the sandbox environment. In order to gain access to the PublicationIQ sandbox environment, please contact EBSCO customer support.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

profile

string

required

EBSCO customer profile. e.g. 'demo.main.pfiguest'

Query Params

sessionid

string

If provided, improves the experience of using the publications search. Sessionid is an optional parameter.

string

required

Keyword search that is applied to limit the results to packages that have the search term in the package name.

orderby

string

enum

required

Valid values are packagename and relevance. Note that orderby will always be treated as 'packagename' when the search term is blank.

Allowed:

offset

string

required

Defaults to 1

Page Offset. Starts at 1.

count

string

required

Defaults to 10

The maximum number of results to return in the response. Maximum count value is 100.

contenttype

string

enum

Limits the results by type of package content. Valid values are all, aggregatedfulltext, abstractandindex, ebook, ejournal, print, unknown and onlinereference. 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 or 7 for online reference.

searchtype

string

enum

Type of search. Search types are any, contains, exactmatch, beginswith, exactphrase and advanced. Searchtype is an optional parameter and defaults to contains if not provided.

Allowed:

searchfield

string

enum

Field to search. e.g. 'KEYWORKD'.

Allowed:

highlighttag

string

subjectfacetcount

string

Max count for subject facets to be returned. e.g. '10'

subjectfacetschemafilter

string

enum

Specify the schema to filter the schema of the subjects facet.

Allowed:

includefacets

boolean

Specify true if search is required to include facet information, false otherwise.

subjectfacet

array of strings

Subject Type Facet filtration option. Required in order to access specific titles via refined results. e.g. 'Medical'

subjectfacet

alphamenufacet

string

Alpha Menu Facet filtration option. Required in order to access specific titles via refined results. Only 1 Alpha Menu Facet value supported in query. e.g. 'A'

packagefreeaccess

string

enum

Allowed:

Headers

password

string

Profile Password (optional). If a password is supplied, it must be a valid password assigned to the customer profile. If omitted, the request will only be honored if the customer profile allows guest access.

Responses

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

502

Bad Gateway

503

Service Unavailable

200OK