Search

get

https://eds-api.ebscohost.com/edsapi/rest/search

This operation is used to perform searches against the databases in the profile. It returns a results list along with the relevant facets and abstracts.

Note: The characters : , ( and ) are used as search syntax and need to be escaped if you want to use them as within a parameter's value.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

query-1

array of strings

required

Specifies what to search for. This parameter may appear multiple times in a request. When evaluating a search request, the order in which the query expressions are evaluated may affects results. This parameter optionally takes an “ordinal” which defines the order when multiple parameters of the same type are found in a search request. If the ordinal is omitted, the parameters will be evaluated from left to right as received. Note: there is no RFC that specifies that the order of parameters will be preserved. [{boolean operator},][{field code}:]{term} boolean operator : (optional) AND | OR | NOT. field Code:(optional) Specifies which searchfield to search for the term in. Valid fields are specified in the metadata supplied by the INFO method. term : (Required) The text to search for

query-1*

includefacets

string

enum

Defaults to y

Specifies whether or not facets should be included in the response. The date range is included in the response when set to y.

Allowed:

facetfilter

array of strings

Specify a facet filter to refine the results of a previous search. Filters are defined in terms of a facet types and values. A facet value group is a collection of one or more pairs of facet types (identified by an ID) and values that are applied as follows to the search. Individual facet filters within a group are OR'd together. If multiple facet filter groups are specified, they are AND'd together. Facets and their values are obtained by specifying the parameter 'includeFacets=y' in the original search request. The response to such a request will include facets and their values that are available for filtering the current results. {filter_Id},{facet_Id}:{value}[,{facet_Id}:{value}]* filter_Id: A number that identifies the filter. The value must be unique within the request. facet_Id: unique ID of the facet. value: The facet value to filter on. example '1,Publisher:wiley-blackwell'

facetfilter

sort

string

Defaults to relevance

Specifies how the search results should be sorted. The available sorts can be obtained from the API’s Info method

limiter

array of strings

Specifies what to further limit the search by. The available limiters are specified in the response from the Info Method. {limiter_Id}:{value}[,{value}]* limiter_Id: (required) The ID of the limiter value: (required) The value(s) to limit by, separated by a comma. (Note: only limiters of type MultiSelectValue will accept more than one value) Example: FT:y

limiter

searchmode

string

enum

Defaults to all

Allows the client to specify the search mode that he wants to be effective with this search

Allowed:

expander

array of strings

Expanders to be applied to this search The available expanders can be obtained from the API’s Info method.

expander

view

string

enum

Defaults to brief

Specifies the level of detail in the records returned.

Allowed:

resultsperpage

integer

Defaults to 20

This indicates the number or records to return with a search request.

pagenumber

integer

Defaults to 1

Specifies the page number of records to return. This is used to determine which records to return for the search. For example, if the results per page is specified as 20 and the page number is set to 2, records 21-40 are returned.

highlight

string

enum

Defaults to y

Specifies whether or not to highlight the search term

Allowed:

action-1

string

Specifies an action used to operate on the current search request. Actions are applied after all query string parameters have been resolved. Actions can optionally specify an ordinal. Like the query parameter, if the ordinal is omitted, the parameters will be evaluated from left to right as received. (see Actions Documentation) Example: addfacetfilter(Journal:backpacker)

relatedcontent

string

Comma separated list of related content types to return with the search results. (see AvailableRelatedContent from the Info method call results for available options)

publicationid

string

Specifies a publication to search within. (only used for profiles configured for publication searching)

autosuggest

string

enum

Defaults to n

Specifies whether or not auto suggestions should be included in the response. (Read more about autosuggestion here.)

Allowed:

autocorrect

string

enum

Defaults to n

Specifies whether or not auto correction should be included in the response.

Allowed:

includeimagequickview

string

enum

Defaults to n

Specifies whether or not the image quick view data is included in search response.

Allowed:

Headers

x-authenticationToken

string

required

Token identifying the caller.

x-sessionToken

string

required

Token identifying the session this call is in relation to.

x-api-key

string

Unique code assigned by EBSCO to monitor access.

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

200OK

400Bad Request