EBSCO Customer ID

Search Term. Keyword search that is applied to limit the results to packages that have the search term in the search field. If no search is given, orderby must be set to '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!.

Field to search. Default is name. Both integer and string are supported. Valid values are name and keyword. It is also valid to use 0 for name or 1 for keyword. Name - Searches on Package Names and Alternative Names. Keyword - Searches on Package Name, Alternative Name, Vendor Name, Managed Description and Custom Description.

Type of search to be performed. Default is contains. Valid values are exactphrase, advanced, any, contains, exactmatch, beginswith. It is also valid to use 1 for exactphrase, 2 for advanced 3 for any, 4 for contains, 5 for exactmatch, or 6 for beginswith. For more information on the search types, see Using Search Types.

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

Limits the results based on customer visibility status per product category. Only functions when selection=selected is included in the request. Valid values are visibleSomewhere, visibleInPF, visibleInFTF, includedInMARC, hiddenSomewhere, hiddenInPF, hiddenInFTF, excludedFromMARC.

Limits the results by type of package content. Default is all. 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.

Specifies order in which Package results are returned. Default is relevance. Valid values are packagename and relevance.

Passing in any value will enable Hit Highlighting, which will highlight which parts of the Package result were matched on during searching. The string passed in is the tag highlighted results will be wrapped in. For example, a highlight tag of 'h' will return < h >The Package Hit < /h > in the response.

Select facets to include in response. Allowed value is 'subject'. Use subjectFacetCount to limit the number of subject facets returned. Default is 1000 when facetsToInclude contains subject.

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

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.