NAV Navbar
cURL Java JavaScript Ruby Python
  • EBSCO PublicationIQ
  • EBSCO PublicationIQ

    Overview

    Welcome to the EBSCO PublicationIQ reference documentation.

    The EBSCO PublicationIQ service provides the ability to search for publications designated as a part of a customer's collection.

    Authentication

    Service Endpoints

    Sandbox Environment
    https://sandbox.ebsco.io    
    
    Production Environment
    https://api.ebsco.io
    

    You will need a valid customer profile in order to access the PublicationIQ service. In order to authenticate to the PublicationIQ service, you need to pass the customer profile as a path parameter with every request.

    Version information

    Version : 1.0.0

    Contact information

    Contact : the EBSCO API Team
    Contact Email : support@ebsco.com

    License information

    License : Copyright EBSCO

    URI scheme

    Sandbox Environment : sandbox.ebsco.io
    Production Environment : api.ebsco.io
    BasePath : /pf/pfaccount Schemes : HTTPS

    Consumes

    Produces

    Resources

    Alpha Browser Resource

    Retrieve an alpha browser menu.

    Get Alpha Browser Menu

    Example Request

    curl -X GET --header 'Accept: application/json' 'https://sandbox.ebsco.io/pf/pfaccount/PROFILE/alphabrowser/menu/LOCALEID?menuid=65'
    
    // Construct the client
    OkHttpClient client = new OkHttpClient();
    
    // Create the URL
    HttpUrl url = new HttpUrl.Builder()
        .scheme("https")
        .host("sandbox.ebsco.io")           
        .addPathSegment("pf")
        .addPathSegment("pfaccount")
        .addPathSegment(PROFILE)
        .addPathSegment("alphabrowser")
        .addPathSegment("menu")
        .addPathSegment(LOCALEID)
        .addQueryParameter("menuid", "65")
        .build();
    
    // Build the request
    Request request = new Request.Builder()
        .url(url)
        .get()
        .addHeader("accept", "application/json")
        .build();
    
    // Send the request
    Response response = client.newCall(request).execute();
    
    var host = "https://sandbox.ebsco.io/pf/pfaccount/";
    var pathsega = "/alphabrowser/menu/";
    
    // Create the Request
    var urlstr = host + PROFILE + pathsega + LOCALEID;
    var settings = {
      "async": true,
      "crossDomain": true,
      "url": urlstr,
      "method": "GET",
       data: { 
        "menuid": "65"
      },
      "headers": {
        "accept": "application/json"
      }
    }
    
    // Send the Request
    $.ajax(settings).done(function (response) {
      console.log(response);
    });
    
    # Form the URL 
    urlstr = File.join('https://sandbox.ebsco.io', '', 'pf/pfaccount', PROFILE, 'alphabrowser/menu', LOCALEID)
    uri = URI(urlstr)
    
    query = URI.encode_www_form({
        # Request parameters
        'menuid' => '65'
    })
    if query.length > 0
      if uri.query && uri.query.length > 0
        uri.query += '&' + query
      else
        uri.query = query
      end
    end
    
    # Create the HTTP object
    http = Net::HTTP.new(uri.host, uri.port)
    http.use_ssl = true
    http.verify_mode = OpenSSL::SSL::VERIFY_NONE
    
    # Create the request
    request = Net::HTTP::Get.new(uri.request_uri)
    request["accept"] = 'application/json'
    
    # Send the request
    response = http.request(request)
    
    # Form the URL
    url = ''.join(['/pf','/pfaccount/', PROFILE, '/alphabrowser/', 'menu/', LOCALEID])
    
    # Create Connection Instance
    conn = http.client.HTTPSConnection("sandbox.ebsco.io")
    
    # Set the Query Parameters
    params = urllib.parse.urlencode({'menuid': '65'})
    
    # Create the Request Headers
    headers = {
        'accept': "application/json"
        }
    
    # Send Request  
    conn.request("GET", url + '?' + params, headers=headers)
    
    # Get Response
    res = conn.getresponse()
    data = res.read()
    

    GET /{profile}/alphabrowser/menu/{localeid}

    Description

    This resource allows you to retrieve an Alpha Browser menu by locale ID and resource type.

    Parameters
    Type Name Description Schema
    Header password
    optional
    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
    Path localeid
    required
    Locale Identifier string
    Path profile
    required
    A valid EBSCO customer profile in the form of custid.groupid.profileid. string
    Query menuid
    required
    Menu ID. Used for filtering menus in position 1. Must be a positive number. string
    Query resourcetype
    optional
    Type of resource. Valid values are book or journal. It is also valid to use 0 for book or 1 for journal. enum (book, journal)
    Query sessionid
    optional
    Session ID. If provided, improves the experience of using the publications search. sessionid is an optional parameter. string
    Responses
    HTTP Code Description Schema
    200 OK, Alpha Browser Menu AlphaBrowserMenuResult
    400 Bad Request No Content
    401 Unauthorized No Content
    500 Internal Server Error No Content
    502 Bad Gateway No Content
    503 Service Unavailable No Content
    Consumes
    Produces

    Package Resources

    Retrieve a list of packages or search for a package.

    Get all Packages

    Example Request

    curl -X GET --header 'Accept: application/json' 'https://sandbox.ebsco.io/pf/pfaccount/PROFILE/allpackages'
    
    // Construct the client
    OkHttpClient client = new OkHttpClient();
    
    // Create the URL
    HttpUrl url = new HttpUrl.Builder()
        .scheme("https")
        .host("sandbox.ebsco.io")           
        .addPathSegment("pf")
        .addPathSegment("pfaccount")
        .addPathSegment(PROFILE)
        .addPathSegment("allpackages")
        .build();
    
    // Build the request
    Request request = new Request.Builder()
        .url(url)
        .get()
        .addHeader("accept", "application/json")
        .build();
    
    // Send the request
    Response response = client.newCall(request).execute();
    
    var host = "https://sandbox.ebsco.io/pf/pfaccount/";
    var pathsega = "/allpackages";
    
    var PROFILE = "PROFILE";
    
    // Create the Request
    var urlstr = host + PROFILE + pathsega;
    var settings = {
      "async": true,
      "crossDomain": true,
      "url": urlstr,
      "method": "GET",
      "headers": {
        "accept": "application/json"
      }
    }
    
    // Send the Request
    $.ajax(settings).done(function (response) {
      console.log(response);
      $('.screen').html(JSON.stringify(response)).fadeIn();
      $('#debugDiv').append('<p>' + urlstr + '</p>');
    });
    
    # Form the URL 
    urlstr = File.join('https://sandbox.ebsco.io', 'pf', 'pfaccount', PROFILE, 'allpackages')
    uri = URI(urlstr)
    
    # Create the HTTP object
    http = Net::HTTP.new(uri.host, uri.port)
    http.use_ssl = true
    http.verify_mode = OpenSSL::SSL::VERIFY_NONE
    
    # Create the request
    request = Net::HTTP::Get.new(uri.request_uri)
    request["accept"] = 'application/json'
    
    # Send the request
    response = http.request(request)
    
    # Form the URL
    url = ''.join(['/pf','/pfaccount/', PROFILE, '/allpackages'])
    
    # Create Connection Instance
    conn = http.client.HTTPSConnection("sandbox.ebsco.io")
    
    # Create the Request Headers
    headers = {
        'accept': "application/json"
        }
    
    # Send Request  
    conn.request("GET", url, headers=headers)
    
    # Get Response
    res = conn.getresponse()
    data = res.read()
    

    GET /{profile}/allpackages

    Description

    This resource allows you to retrieve a list of all packages from EPKB limited to a single customer ID. The response will reflect the context of the EBSCO customer ID included in the request.

    Parameters
    Type Name Description Schema
    Header password
    optional
    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
    Path profile
    required
    A valid EBSCO customer profile in the form of custid.groupid.profileid. string
    Query contenttype
    optional
    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. enum (all, aggregatedfulltext, abstractandindex, ebook, ejournal, print, unknown, onlinereference)
    Query sessionid
    optional
    Session ID. If the Session ID is provided, it improves the experience of using the publications search. sessionid is an optional parameter. string
    Responses
    HTTP Code Description Schema
    200 OK, List of all Packages GetAllPackagesResult
    400 Bad Request No Content
    401 Unauthorized No Content
    500 Internal Server Error No Content
    502 Bad Gateway No Content
    503 Service Unavailable No Content
    Consumes
    Produces

    Get Packages by Package Name

    Example Request

    curl -X GET --header 'Accept: application/json' 'https://sandbox.ebsco.io/pf/pfaccount/PROFILE/packages?search=boston&offset=1&count=50&orderby=relevance'
    
    // Construct the client
    OkHttpClient client = new OkHttpClient();
    
    // Create the URL
    HttpUrl url = new HttpUrl.Builder()
        .scheme("https")
        .host("sandbox.ebsco.io")           
        .addPathSegment("pf")
        .addPathSegment("pfaccount")
        .addPathSegment(PROFILE)
        .addPathSegment("packages")
        .addQueryParameter("search", "a")
        .addQueryParameter("offset", "1")
        .addQueryParameter("count", "50")
        .addQueryParameter("orderby", "relevance")
        .build();
    
    // Build the request
    Request request = new Request.Builder()
        .url(url)
        .get()
        .addHeader("accept", "application/json")
        .build();
    
    // Send the request
    Response response = client.newCall(request).execute();
    
    var host = "https://sandbox.ebsco.io/pf/pfaccount/";
    var pathsega = "/packages";
    
    // Create the Request
    var urlstr = host + PROFILE + pathsega;
    var settings = {
      "async": true,
      "crossDomain": true,
      "url": urlstr,
      "method": "GET",
       data: { 
        "search": "boston",
        "offset": "1",
        "count": "50",
        "orderby": "relevance"
      },
      "headers": {
        "accept": "application/json"
      }
    }
    
    // Send the Request
    $.ajax(settings).done(function (response) {
      console.log(response);
    });
    
    # Form the URL 
    urlstr = File.join('https://', 'sandbox.ebsco.io', 'pf', 'pfaccount', PROFILE, 'packages')
    uri = URI(urlstr)
    
    query = URI.encode_www_form({
        # Request parameters
        'search' => 'boston',
        'offset' => '1',
        'count' => '50',
        'orderby' => 'relevance'
    })
    if query.length > 0
      if uri.query && uri.query.length > 0
        uri.query += '&' + query
      else
        uri.query = query
      end
    end
    
    # Create the HTTP object
    http = Net::HTTP.new(uri.host, uri.port)
    http.use_ssl = true
    http.verify_mode = OpenSSL::SSL::VERIFY_NONE
    
    # Create the request
    request = Net::HTTP::Get.new(uri.request_uri)
    request["accept"] = 'application/json'
    
    # Send the request
    response = http.request(request)
    
    # Form the URL
    url = ''.join(['/pf','/pfaccount/', PROFILE, '/packages'])
    
    # Create Connection Instance
    conn = http.client.HTTPSConnection("sandbox.ebsco.io")
    
    # Set the Query Parameters
    params = urllib.parse.urlencode({'search': 'boston', 'offset': '1', 'count': '50', 'orderby': 'relevance'})
    
    # Create the Request Headers
    headers = {
        'accept': "application/json"
        }
    
    # Send Request  
    conn.request("GET", url + '?' + params, headers=headers)
    
    # Get Response
    res = conn.getresponse()
    

    GET /{profile}/packages

    Description

    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.

    Parameters
    Type Name Description Schema Default
    Header password
    optional
    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
    Path profile
    required
    A valid EBSCO customer profile in the form of custid.groupid.profileid. string
    Query contenttype
    optional
    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. enum (all, aggregatedfulltext, abstractandindex, ebook, ejournal, print, unknown, onlinereference)
    Query count
    required
    The maximum number of results to return in the response. Maximum count value is 100. integer (int32) 50
    Query offset
    required
    Page Offset. Starts at 1. integer (int64) 1
    Query orderby
    required
    Valid values are packagename and relevance. enum (relevance, packagename)
    Query search
    optional
    Keyword search that is applied to limit the results to packages that have the search term in the package name. string
    Query sessionid
    optional
    Session ID. If provided, improves the experience of using the publications search. sessionid is an optional parameter. string
    Responses
    HTTP Code Description Schema
    200 OK, List of Packages GetPackagesResult
    400 Bad Request No Content
    401 Unauthorized No Content
    500 Internal Server Error No Content
    502 Bad Gateway No Content
    503 Service Unavailable No Content
    Consumes
    Produces

    Title Resources

    Retrieve a list of publications or search for a publication by title ID.

    Get Publication by Title ID

    Example Request

    curl -X GET --header 'Accept: application/json' 'https://sandbox.ebsco.io/pf/pfaccount/PROFILE/packages/PACKAGEID/titles/KBID'
    
    // Construct the client
    OkHttpClient client = new OkHttpClient();
    
    // Create the URL
    HttpUrl url = new HttpUrl.Builder()
        .scheme("https")
        .host("sandbox.ebsco.io")           
        .addPathSegment("pf")
        .addPathSegment("pfaccount")
        .addPathSegment(PROFILE)
        .addPathSegment("packages")
        .addPathSegment(PACKAGEID)
        .addPathSegment("titles")
        .addPathSegment(KBID)
        .build();
    
    // Build the request
    Request request = new Request.Builder()
        .url(url)
        .get()
        .addHeader("accept", "application/json")
        .build();
    
    // Send the request
    Response response = client.newCall(request).execute();
    
    var host = "https://sandbox.ebsco.io/pf/pfaccount/";
    var pathsega = "/packages/";
    var pathsegb = "/titles/";
    
    // Create the Request
    var urlstr = host + PROFILE + pathsega + PACKAGEID + pathsegb + KBID;
    var settings = {
      "async": true,
      "crossDomain": true,
      "url": urlstr,
      "method": "GET",
      "headers": {
        "accept": "application/json"
      }
    }
    
    // Send the Request
    $.ajax(settings).done(function (response) {
      console.log(response);
    });
    
    # Form the URL 
    urlstr = File.join('https://', 'sandbox.ebsco.io', 'pf', 'pfaccount', PROFILE, 'packages', PACKAGEID, 'titles', KBID)
    uri = URI(urlstr)
    
    # Create the HTTP object
    http = Net::HTTP.new(uri.host, uri.port)
    http.use_ssl = true
    http.verify_mode = OpenSSL::SSL::VERIFY_NONE
    
    # Create the request
    request = Net::HTTP::Get.new(uri.request_uri)
    request["accept"] = 'application/json'
    
    # Send the request
    response = http.request(request)
    
    # Form the URL
    url = ''.join(['/pf','/pfaccount/', PROFILE, '/packages/', PACKAGEID, '/titles/', KBID])
    
    # Create Connection Instance
    conn = http.client.HTTPSConnection("sandbox.ebsco.io")
    
    # Create the Request Headers
    headers = {
        'accept': "application/json"
        }
    
    # Send Request  
    conn.request("GET", url, headers=headers)
    

    GET /{profile}/packages/{packageid}/titles/{kbid}

    Description

    This resource allows you to retrieve a publication by title ID.

    Parameters
    Type Name Description Schema
    Header password
    optional
    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
    Path kbid
    required
    Title ID string
    Path packageid
    required
    Package ID string
    Path profile
    required
    A valid EBSCO customer profile in the form of customerid.groupid.profileid. string
    Query sessionid
    optional
    Session ID. If session ID is used, it will improve the experience of using the publications search. sessionid is an optional parameter. string
    Responses
    HTTP Code Description Schema
    200 OK, Publication Record
    400 Bad Request No Content
    401 Unauthorized No Content
    500 Internal Server Error No Content
    502 Bad Gateway No Content
    503 Service Unavailable No Content
    Consumes
    Produces

    Get Publications by Specified Title Attributes

    Example Request

    curl -X GET --header 'Accept: application/json' 'https://sandbox.ebsco.io/pf/pfaccount/PROFILE/publications?search=a&offset=1&count=50&orderby=relevance&searchfield=titlename&includefacets=true&searchtype=any'
    
    // Construct the client
    OkHttpClient client = new OkHttpClient();
    
    // Create the URL
    HttpUrl url = new HttpUrl.Builder()
        .scheme("https")
        .host("sandbox.ebsco.io")           
        .addPathSegment("pf")
        .addPathSegment("pfaccount")
        .addPathSegment(PROFILE)
        .addPathSegment("publications")
        .addQueryParameter("search", "boston")
        .addQueryParameter("offset", "1")
        .addQueryParameter("count", "50")
        .addQueryParameter("orderby", "relevance")
        .addQueryParameter("searchfield", "titlename")
        .addQueryParameter("includefacets", "true")
        .addQueryParameter("searchtype", "any")         
        .build();
    
    // Build the request
    Request request = new Request.Builder()
        .url(url)
        .get()
        .addHeader("accept", "application/json")
        .build();
    
    // Send the request
    Response response = client.newCall(request).execute();
    
    var host = "https://sandbox.ebsco.io/pf/pfaccount/";
    var pathsega = "/publications";
    
    // Create the Request
    var urlstr = host + PROFILE + pathsega;
    var settings = {
      "async": true,
      "crossDomain": true,
      "url": urlstr,
      "method": "GET",
       data: { 
        "search": "boston",
        "offset": "1",
        "count": "50",
        "orderby": "relevance",
        "searchfield": "titlename",
        "includefacets": "true",
        "searchtype": "any"
      },
      "headers": {
        "accept": "application/json"
      }
    }
    
    // Send the Request
    $.ajax(settings).done(function (response) {
      console.log(response);
    });
    
    # Form the URL 
    urlstr = File.join('https://', 'sandbox.ebsco.io', 'pf', 'pfaccount', PROFILE, 'publications')
    uri = URI(urlstr)
    
    query = URI.encode_www_form({
        # Request parameters
        'search' => 'boston',
        'offset' => '1',
        'count' => '50',
        'orderby' => 'relevance',
        'searchfield' => 'titlename',
        'includefacets' => 'true',
        'searchtype' => 'any'
    })
    if query.length > 0
      if uri.query && uri.query.length > 0
        uri.query += '&' + query
      else
        uri.query = query
      end
    end
    
    # Create the HTTP object
    http = Net::HTTP.new(uri.host, uri.port)
    http.use_ssl = true
    http.verify_mode = OpenSSL::SSL::VERIFY_NONE
    
    # Create the request
    request = Net::HTTP::Get.new(uri.request_uri)
    request["accept"] = 'application/json'
    
    # Send the request
    response = http.request(request)
    
    # Form the URL
    url = ''.join(['/pf','/pfaccount/', PROFILE, '/publications'])
    
    # Create Connection Instance
    conn = http.client.HTTPSConnection("sandbox.ebsco.io")
    
    # Set the Query Parameters
    params = urllib.parse.urlencode({'search': 'boston', 'offset': '1', 'count': '50', 'orderby': 'relevance', 'searchfield': 'titlename', 'includefacets': 'true', 'searchtype': 'any'})
    
    # Create the Request Headers
    headers = {
        'accept': "application/json"
        }
    
    # Send Request  
    conn.request("GET", url + '?' + params, headers=headers)
    
    # Get Response
    res = conn.getresponse()
    

    GET /{profile}/publications

    Description

    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.

    Parameters
    Type Name Description Schema Default
    Header password
    optional
    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
    Path profile
    required
    A valid EBSCO customer profile in the form of customerid.groupid.profileid. string
    Query alphamenufacet
    optional
    Alpha Menu Facet facet filter. Limits the results. alphamenufacet is an optional parameter. One alphamenufacet is supported in a query. string
    Query alphamenufacetcount
    optional
    Maximum number of alphamenu facets to be returned. integer (int32)
    Query count
    required
    The maximum number of results to return in the response. Maximum count value is 100. integer (int32) 50
    Query includefacets
    required
    Specify true if search is required to include facet information, false otherwise. enum (true, false)
    Query ispeerreviewed
    optional
    Specify true if search is required to include facet information for "isPeerReviewed" title metadata, false otherwise. enum (true, false)
    Query offset
    required
    Page Offset. Starts at 1. integer (int64) 1
    Query orderby
    required
    Valid values are titlename and relevance. enum (relevance, titlename)
    Query packagefacet
    optional
    Package type facet filter. Limits the results. packagefacet is an optional parameter. < string > array(multi)
    Query packagefacetcount
    optional
    Maximum number of package facets to be returned. integer (int32)
    Query platform
    optional
    Platform that the search is made from. string
    Query resourcetype
    optional
    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. string
    Query resourcetypefacet
    optional
    Resource type facet filter. Limits the results. resourcetypefacet is an optional parameter. < string > array(multi)
    Query resourcetypefacetcount
    optional
    Maximum number of resource type facets to be returned. integer (int32)
    Query search
    optional
    Keyword search that is applied to limit the results to publications that have the search term in the title name. string
    Query searchfield
    required
    Field to search. Valid values are titlename, subject, isxn or publisher. enum (titlename, subject, isxn, publisher)
    Query searchtype
    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. enum (any, contains, exactmatch, beginswith, proximity, exactphrase, advanced)
    Query sessionid
    optional
    Session ID. If session ID is used, it will improve the experience of using the publications search. sessionid is an optional parameter. string
    Query source
    optional
    Source of the request. string
    Query subjectfacet
    optional
    Subject type facet filter. Limits the results. subjectfacet is an optional parameter. < string > array(multi)
    Query subjectfacetcount
    optional
    Maximum number of subject facets to be returned. integer (int32)
    Query subjectfacetschemafilter
    optional
    Specifies the schema to filter by for the subjects facet. Valid values are tli, bisac, medical or library of congress. enum (tli, bisac, medical, library of congress)
    Responses
    HTTP Code Description Schema
    200 OK, List of Publications PublicationSearchResultWrapper
    400 Bad Request No Content
    401 Unauthorized No Content
    500 Internal Server Error No Content
    502 Bad Gateway No Content
    503 Service Unavailable No Content
    Consumes
    Produces

    Definitions

    AllPackagesResponse

    Name Description Schema
    packageId
    optional
    Package Identifier
    Example : 22551
    integer (int64)
    packageName
    optional
    Package Name
    Example : "123Library eBooks"
    string
    contentType
    optional
    Content type. Valid values are All, AggregatedFullText, AbstractandIndex, EBook, EJournal, Print, Unknown and OnlineReference.
    Example : "EBook"
    string

    AlphaBrowserMenuItem

    Name Description Schema
    menuId
    optional
    Menu ID
    Example : 65
    integer (int32)
    characters
    optional
    Characters
    Example : "A"
    string
    order
    optional
    Order
    Example : 2
    integer (int32)
    count
    optional
    Count
    Example : 4487
    integer (int32)

    AlphaBrowserMenuResult

    Name Schema
    position 0
    optional
    < AlphaBrowserMenuItem > array
    position 1
    optional
    < AlphaBrowserMenuItem > array
    position 2
    optional
    < AlphaBrowserMenuItem > array
    position 3
    optional
    < AlphaBrowserMenuItem > array

    AlphaMenuFacet

    Name Description Schema
    AlphaMenu
    optional
    Alpha Menu
    Example : "AA"
    string
    count
    optional
    Count
    Example : 1
    integer (int64)

    CustomCoverage

    Dates of Coverage

    Name Description Schema
    beginCoverage
    required
    Coverage Start Date
    Example : "2003-01-01"
    string
    endCoverage
    required
    Coverage End Date
    Example : "2003-12-12"
    string

    Data

    Name Description Schema
    RecordFormat
    optional
    Record Format. The format of the record (e.g., HTML, PDF, Video, etc.)
    Example : "HTML"
    string
    Records
    optional
    < Record > array

    Facets

    Name Schema
    Subjects
    optional
    < SubjectFacet > array
    ResourceTypes
    optional
    < ResourceTypeFacet > array
    Packages
    optional
    < PackageFacet > array
    AlphaMenus
    optional
    < AlphaMenuFacet > array
    IsPeerReviewed
    optional
    < IsPeerReviewedFacet > array

    GetAllPackagesResult

    Name Description Schema
    packagesList
    optional
    < AllPackagesResponse > array
    totalResults
    optional
    Total Results
    Example : 341
    integer (int64)

    GetPackagesResult

    Name Description Schema
    packagesList
    optional
    < PsmPackage > array
    totalResults
    optional
    Total Results
    Example : 323
    integer (int64)

    IdentifiersList

    Name Description Schema
    id
    optional
    Identifier Value
    Example : "1"
    string
    source
    optional
    Resource Identifier
    Example : "AtoZ"
    string
    subtype
    optional
    Sub-type for the identifier. This is used by only some identifiers to designate Print, Online, etc. Empty=0, Print=1, Online=2, Preceding=3, Succeeding=4, Regional=5, Linking=6 and Invalid=7
    Example : 1
    integer (int64)
    type
    optional
    integer (int64)

    IsPeerReviewedFacet

    Name Description Schema
    isPeerReviewed
    optional
    Is it Peer Reviewed
    Example : true
    boolean
    count
    optional
    Count
    Example : 9
    integer (int64)

    PFEmbargoPeriod

    Embargo Period

    Name Description Schema
    embargoUnit
    required
    The unit of time to use for the embargo - Days, Weeks, Months or Years.
    Example : "Days"
    enum (Days, Weeks, Months, Years)
    embargoValue
    required
    The embargo value (number of embargoUnits). A Null value means there is no embargo.
    Example : 1
    integer

    PackageFacet

    Name Description Schema
    id
    optional
    Package ID
    Example : "1615"
    string
    Package
    optional
    Package Name
    Example : "Academic Search Complete"
    string
    count
    optional
    Count
    Example : 15
    integer (int64)

    PfAlternateTitle

    Name Description Schema
    alternateTitle
    optional
    Alternate Title
    Example : "Boston Pilot"
    string
    titleType
    optional
    Title Type
    Example : "b202"
    string

    PfContributor

    Name Description Schema
    contributor
    optional
    Contributor Name
    Example : "Jon Doe"
    string
    type
    optional
    Type of contributor. Valid values are Author, Illustrator, and Editor.
    Example : "Editor"
    string

    PfCustomerResource

    Name Description Schema
    titleId
    optional
    Title ID
    Example : 1157191
    integer (int64)
    packageId
    optional
    EBSCO KB's unique identifier for the package. In EPKB, this is 'PkgID'.
    Example : 1117849
    integer (int64)
    packageName
    optional
    Name of the Package. In EPKB, this is 'PkgName'.
    Example : "Health & Wellness Resource Center (w/alt health module)"
    string
    packageType
    optional
    Package Type. Valid values are Selectable, Complete, Variable and Custom.
    Example : "Complete"
    string
    isPackageCustom
    optional
    Is the Package Custom.
    Example : false
    boolean
    vendorId
    optional
    EBSCO KB's unique identifier for the provider. In EPKB, this is 'VendorID'.
    Example : 19
    integer (int64)
    vendorName
    optional
    Provider name. In EPKB, this is the 'VendorName'.
    Example : "EBSCO"
    string
    locationId
    optional
    Location ID
    Example : 1033
    integer (int64)
    isSelected
    optional
    Indicates if selected in a customer's account.
    Example : false
    boolean
    isTokenNeeded
    optional
    Field to indicate if a token is needed
    Example : false
    boolean
    managedCoverageList
    optional
    < CustomCoverage > array
    customCoverageList
    optional
    < CustomCoverage > array
    coverageStatement
    optional
    Coverage Statement
    Example : "Issues on or after 6/1/1992"
    string
    managedEmbargoPeriod
    optional
    PFEmbargoPeriod
    customEmbargoPeriod
    optional
    PFEmbargoPeriod
    url
    optional
    url
    Example : "http://search.ebscohost.com/direct.asp?db=h9i&jid=6IJ3&scope=site"
    string
    packageToken
    optional
    PfToken
    vendorToken
    optional
    PfToken
    note
    optional
    < PfNote > array
    userDefinedFields
    optional
    < UserDefinedField > array
    visibilityData
    optional
    VisibilityDataKbid
    linkOutTargetUrl
    optional
    Link Out Target URL
    Example : "https://api.ebsco.io/pf/externallink?params=rO0ABXNyAEhjb20uZWJzY28ua25vd2xlZGdlYmFzZS5wZmFwaS5zZXJ2aWNlLmxpbmtidWlsZGVyLkV4dGVybmFsTGlua1BhcmFtZXRlcnNndKNO6WP5LQIAC0wACmN1c3RvbWVySWR0ABJMamF2YS9sYW5nL1N0cmluZztMAAdncm91cElkcQB-AAFMAAZob3N0SXBxAH4AAUwACXBhY2thZ2VJZHQAEExqYXZhL2xhbmcvTG9uZztMAAhwbGF0Zm9ybXEAfgABTAAJcHJvZmlsZUlkcQB-AAFMAAlzZXNzaW9uTm9xAH4AAkwABnNvdXJjZXEAfgABTAAJdGltZXN0YW1wcQB-AAJMAAd0aXRsZUlkcQB-AAJMAAZ1c2VySWRxAH4AAnhwdAAEZGVtb3QABG1haW50AAwxMC4yNi4xNzIuNTFzcgAOamF2YS5sYW5nLkxvbmc7i-SQzI8j3wIAAUoABXZhbHVleHIAEGphdmEubGFuZy5OdW1iZXKGrJUdC5TgiwIAAHhwAAAAAAAAD1ZwdAAIcGZpZ3Vlc3RzcQB-AAfkSuFGttYaRXBzcQB-AAcAAAFr4O71ZHNxAH4ABwAAAAAAC6l4c3EAfgAHAAAAAAAABZZ"
    string
    targetUrl
    optional
    Target URL
    Example : "http://target.url.io"
    string

    PfNote

    Name Description Schema
    id
    optional
    Unique identifier for the note
    Example : 309
    integer (int64)
    custId
    optional
    Customer ID
    Example : 1234
    integer (int64)
    noteName
    optional
    Note name
    Example : "Note-1"
    string
    rank
    optional
    Rank
    Example : 1
    integer (int64)
    noteText
    optional
    Note text to be displayed on the menu
    Example : "Note-1 text."
    string
    iconUrl
    optional
    If customer uses own icon for a note, this is its URL. Null if no icon or using standard icon
    Example : "http://hostname.com/icon.png"
    string
    iconId
    optional
    Unique identifier for the icon
    Example : 45
    integer (int64)
    altText
    optional
    Text to show on mouse-over.
    Example : "forbidden"
    string
    hoverText
    optional
    Hover text to show on mouse-over for the note
    Example : "Sample Icon Hover Text"
    string
    linkUrl
    optional
    URL of the note link if any
    Example : "http://hostname.com"
    string
    showOnFlags
    optional
    < string > array

    PfSubject

    Name Description Schema
    type
    optional
    The type of subject. Valid values are BISAC and TLI.
    Example : "BISAC"
    enum (BISAC, TLI)
    name
    optional
    Subject Name
    Example : "Subject Name"
    string

    PfToken

    Name Description Schema
    factName
    optional
    Fact Name
    Example : "[[SiteID]]"
    string
    value
    optional
    Value
    Example : "1234567"
    string

    PsmPackage

    Name Description Schema
    contentType
    optional
    Content type. Valid values are All, AggregatedFullText, AbstractandIndex, EBook, EJournal, Print, Unknown and OnlineReference.
    Example : "EBook"
    string
    customCoverage
    optional
    CustomCoverage
    isCustom
    optional
    isCustom is true if a customer is the vendor. The customer vendor is used for custom packages.
    Example : true
    boolean
    isSelected
    optional
    Indicates if the packages is selected in a customer's account.
    Example : true
    boolean
    isTokenNeeded
    optional
    Field to indicate if a token is needed
    Example : true
    boolean
    packageId
    optional
    Package Identifier
    Example : 175
    integer (int64)
    packageName
    optional
    Package Name
    Example : "Health Source: Nursing/Academic Edition"
    string
    packageType
    optional
    Package Type. Valid values are Selectable, Complete, Variable and Custom.
    Example : "Complete"
    string
    selectedCount
    optional
    Numeric value indicating the number of titles in packages selected in the customer account.
    Example : 328
    integer (int64)
    titleCount
    optional
    Numeric value indicating the title count of the package.
    Example : 328
    integer (int64)
    vendorId
    optional
    EBSCO KB's unique identifier for the provider. In EPKB, this is 'VendorID'.
    Example : 19
    integer (int64)
    vendorName
    optional
    Provider name. In EPKB, this is the 'VendorName'.
    Example : "EBSCO"
    string
    visibilityData
    optional
    VisibilityData

    PublicationSearchResult

    Name Schema
    Sessiondetails
    optional
    Sessiondetails
    Statistics
    optional
    Statistics
    Data
    optional
    Data

    PublicationSearchResultWrapper

    Name Schema
    SearchRequestGet
    optional
    SearchRequestGet
    Facets
    optional
    Facets
    SearchResult
    optional
    PublicationSearchResult

    QueriesWithAction

    Name Schema
    Query
    optional
    Query

    Query

    Name Description Schema
    BooleanOperator
    optional
    Boolean Operator
    Example : "Boolean Operator"
    string
    Term
    optional
    Query Term
    Example : "Query Term"
    string

    Record

    Name Description Schema
    titleId
    optional
    Title ID
    Example : "1157191"
    string
    titleName
    optional
    Title Name
    Example : "Boston Pilot (Boston, MA)"
    string
    edition
    optional
    Title Edition
    Example : "1"
    string
    description
    optional
    Title Description
    Example : "Description Test."
    string
    isPeerReviewed
    optional
    Is this title peer reviewed.
    Example : false
    boolean
    publisherName
    optional
    Publisher Name
    Example : "www.ebsco.com"
    string
    identifiersList
    optional
    < IdentifiersList > array
    subjectsList
    optional
    < PfSubject > array
    isTitleCustom
    optional
    Is this a custom title owned by the customer.
    Example : true
    boolean
    pubType
    optional
    Type of publication. Valid values are journal, newsletter, report, proceedings, website, newspaper, unspecified, book, bookseries, database, thesisdissertation, streamingaudio, streamingvideo, and audiobook.
    Example : "Book"
    string
    contributorsList
    optional
    < PfContributor > array
    customerResourcesList
    optional
    < PfCustomerResource > array
    duration
    optional
    Duration
    Example : "123"
    string
    frequency
    optional
    Frequency
    Example : "52"
    string
    alternateTitleList
    optional
    < PfAlternateTitle > array

    RequestParams

    Name Description Schema
    sessionId
    optional
    Session ID
    Example : "11223344"
    string
    customerId
    optional
    Customer ID
    Example : 1123
    integer (int64)

    ResourceTypeFacet

    Name Description Schema
    ResourceTypes
    optional
    Resource Type. Valid values are all, journal, newsletter, report, proceedings, website, newspaper, unspecified, book, bookseries, database, thesisdissertation, streamingaudio, streamingvideo, and audiobook.
    Example : "book"
    string
    count
    optional
    Count
    Example : 358
    integer (int64)

    SearchCriteriaWithActions

    Name Schema
    QueriesWithAction
    optional
    < QueriesWithAction > array

    SearchRequestGet

    Name Schema
    RequestParams
    optional
    RequestParams
    SearchCriteriaWithActions
    optional
    SearchCriteriaWithActions

    Sessiondetails

    Name Description Schema
    sessionid
    optional
    Session ID
    Example : "1996535790953948603"
    string

    Statistics

    Name Description Schema
    TotalHits
    optional
    Total Hits
    Example : 815
    integer (int64)
    TotalSearchTime
    optional
    Total Search Time
    Example : 1729
    integer (int64)

    SubjectFacet

    Name Description Schema
    SubjectName
    optional
    Subject
    Example : "ART / General"
    string
    count
    optional
    Count
    Example : 25
    integer (int64)
    id
    optional
    ID
    Example : "8005"
    string
    parentId
    optional
    Parent ID
    Example : "null"
    string

    UserDefinedField

    Name Description Schema
    displayOnPublicationFinder
    optional
    Is displayed on the Publication Finder
    Example : true
    boolean
    id
    optional
    ID
    Example : "a123"
    integer (int64)
    label
    optional
    User Defined Field Label
    Example : "Field A"
    string
    value
    optional
    User Defined Field Value
    Example : "User Defined Field Value"
    string

    VisibilityData

    Visibility

    Name Description Schema
    isHidden
    required
    Is Hidden
    Example : true
    boolean
    reason
    optional
    Reason
    Example : "Hidden by Customer"
    string

    VisibilityDataKbid

    Visibility

    Name Description Schema
    isHidden
    required
    Is Hidden
    Example : true
    boolean