Returns publications by specified title attribute

get

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

This operation allows you to search for publications and returns a list of publications. The list is limited to a single customer ID. The response will reflect the context of the EBSCO customer ID included in the request.

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

alphamenufacetcount

integer

≥ 0

^[0-9]+$

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

highlighttag

string

HTML tag that determines styling of the item. e.g. 'mark'

linkfrom

string

Where external links are displayed on a web page. e.g. 'PublicationResultList'

packagefacet

array of strings

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

packagefacet

packagefacetcount

integer

≥ 0

^[0-9]+$

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

peerreviewed

boolean

Specify true if search is required to include facet information for "PeerReviewed" title metadata, false otherwise.

platform

string

Platform search is made from. e.g. 'AWS'

resourcetype

string

enum

Type of resource. e.g. 'JOURNAL'

resourcetypefacet

array of strings

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

resourcetypefacet

resourcetypefacetcount

integer

≥ 0

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

string

Required to bound search result to specific search value. e.g. 'nature'

searchtype

string

enum

Defaults to CONTAINS

Type of search. e.g. 'ANY'

Allowed:

sessionid

string

Already existing SessionId can be provided to improve experience of using the publications search. Example format -> '-2689046726050171609'

source

string

Source of the request. e.g. 'pfi'

subjectfacetcount

integer

≥ 0

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. e.g. 'TLI'

Allowed:

count

integer

required

1 to 100

The maximum number of results to return in the response. Maximum allowed count value is 100. e.g. '10'

includefacets

boolean

required

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

offset

integer

required

≥ 1

Page number. Starts from 1. e.g. '1'

orderby

string

enum

required

Order in which the publications will be returned. e.g. 'RELEVANCE'. Note that orderby will always be treated as 'TITLENAME' when the search term is blank.

Allowed:

searchfield

string

enum

required

Field to search. e.g. 'TITLENAME'. The 'Contributor' search field is equivalent to the 'Author' search field in the EBSCO Publication Finder User Interface

Allowed:

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'

returnrelativeimagelinks

boolean

Return relative links or direct links to cover images

size

string

enum

Cover image size. e.g. thumb

Allowed:

subjectfacet

array of strings

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

subjectfacet

packagefreeaccess

string

enum

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

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.

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

502

Bad Gateway

503

Service Unavailable

200OK, Wrapper encompassing details returned from publication finder service call