Deprecated - Get Publications by Specified Title Attributes

get

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

This resource has been deprecated in favor of /pf/v1/pfaccount/{profile}/publications. This resource 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. 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

A valid EBSCO customer profile in the form of customerid.groupid.profileid.

Query Params

resourcetypefacet

array of strings

Resource type facet filter. Limits the results. resourcetypefacet is an optional parameter.

resourcetypefacet

packagefacet

array of strings

Package type facet filter. Limits the results. packagefacet is an optional parameter.

packagefacet

subjectfacet

array of strings

Subject type facet filter. Limits the results. subjectfacet is an optional parameter.

subjectfacet

sessionid

string

Session ID. If session ID is used, it will improve the experience of using the publications search. sessionid is an optional parameter.

string

Keyword search that is applied to limit the results to publications that have the search term in the title name.

offset

int64

required

Defaults to 1

Page Offset. Starts at 1.

count

int32

required

Defaults to 50

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

orderby

string

enum

required

Valid values are titlename and relevance.

Allowed:

searchfield

string

enum

required

Field to search. Valid values are titlename, subject, isxn or publisher.

Allowed:

includefacets

string

enum

required

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

Allowed:

searchtype

string

enum

required

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

Allowed:

resourcetype

string

Type of resource. Valid values are Journal, Newsletter, Report, Proceedings, Web site, Newspaper, Unspecified, Book, Book Series, Database, Thesis/Dissertation, Streaming Audio, Streaming, Video or Audio Book. resourcetype is an optional parameter.

alphamenufacet

string

Alpha Menu Facet facet filter. Limits the results. alphamenufacet is an optional parameter. One alphamenufacet is supported in a query.

ispeerreviewed

string

enum

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

Allowed:

subjectfacetschemafilter

string

enum

Specifies the schema to filter by for the subjects facet. Valid values are tli, bisac, medical or library of congress.

Allowed:

subjectfacetcount

int32

Maximum number of subject facets to be returned.

packagefacetcount

int32

Maximum number of package facets to be returned.

alphamenufacetcount

int32

Maximum number of alphamenu facets to be returned.

resourcetypefacetcount

int32

Maximum number of resource type facets to be returned.

source

string

Source of the request.

platform

string

Platform that the search is made from.

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

500

Internal Server Error

502

Bad Gateway

503

Service Unavailable

200OK, List of Publications