On Wednesday January 24, 2018, version 1.3.10 of the Enhanced PRH API was released to production. If you encounter any problems with your applications as a result of these changes, please contact us at api@penguinrandomhouse.com.

Version 1.3.10 release notes

This version introduces two new features. The first of these is a new Title view for the PEEPS project.

/domains/PRH.US/titles/9780525483427/views/peeps

  "data": {
    "ean": 9780525483427,
    "title": "The Crooked Staircase",
    "author": "Dean Koontz",
    "salesRestriction": {
      "code": "07",
      "description": "US, Canada, Open Mkt"
    },
    "saleStatus": "IN",
    "format": {
      "code": "HC",
      "description": "Hardcover"
    },
    "subformat": {
      "code": null,
      "description": null
    },
    "productLine": "141",
    "productType": "025",
    "division": {
      "code": "12",
      "description": "Bantam Dell"
    },
    "frontlistiestSeq": 1,
    "language": "E",
    "age": {
      "code": null,
      "description": null
    },
    "onsale": "2018-05-08",
    "titleBlock": null,
    "hasCoverImage": true,
    "workId": 573049,
    "flapCopy": "Jane Hawk—who dazzled readers in...",
    "subjects": [
      {
        "code": "FIC030000",
        "description": "Fiction - Thrillers - Suspense"
      },
      {
        "code": "FIC002000",
        "description": "Fiction - Action & Adventure"
      },
      {
        "code": "FIC025000",
        "description": "Fiction - Psychological"
      }
    ],
    "authors": [
      {
        "code": "16127",
        "description": "Dean Koontz"
      }
    ]
  },

The other new feature is a new flag added to the product display view to identify library binding ISBNs. Hardcover Library Binding titles have a format description that has been cleaned to simply "Hardcover" so this flag is needed to be able to distinguish them from the other HC edition.

/domains/PRH.US/titles/9781524715403/views/product-display

"flags": [
    "LIBRARY_BINDING"
],

Bug

• [RHAPI-846] - Author ID #4881 still present in Solr collection
• [RHAPI-853] - Ordering of titles within author on PRH.com

New Feature

• [RHAPI-859] - Create title view for PEEPS
• [RHAPI-863] - Add LIBRARY_BINDING flag to Product Display view

Task

• [RHAPI-847] - Create AUTHOR_DELETES table
• [RHAPI-854] - Refactor api load script to generate delete documents on initialization.
• [RHAPI-858] - Identify deleted work IDs
• [RHAPI-862] - Remove deleted work IDs from Solr

On Wednesday December 20, 2017, version 1.3.9 of the Enhanced PRH API was released to production. If you encounter any problems with your applications as a result of these changes, please contact us at api@penguinrandomhouse.com.

Version 1.3.9 release notes

This release includes some bug fixes and new features to support the Sales websites and PRH United app. Among the new features are a couple of new parameters.

Zoom categories

One of these new parameters is zoomCatSetId which RHAPI-829 shows is necessary whenever the zoom parameter identifies that we want to include categories. If we need to limit the category set from which the categories are drawn and yet we don't want that category set to be a limit on the titles that are being returned from the primary listing, then the zoomCatSetId should be specified and the category listing will be filtered but the listing will not be.

Award filtering

We've always supported the showAwards parameter which will restrict results to just titles that have won an award. However you may now specify one or more awardLevel and awardDesc parameters to filter any listing based on specific entries in the ISBNxAWARD table. Here is a sample request:

/domains/PRH.US/works?awardLevel=WINNER&awardDesc=Man%20Booker%20Prize

This will allow for a more customized and granular approach to finding a specific award winner or for finding a list of titles or works that have one of several prizes in common. If you need more information on awards or the possible values for these parameters, please contact us at api@penguinrandomhouse.com.

Bug

• [RHAPI-829] - /title end point with categories zoom returns an error when the title has no categories
• [RHAPI-841] - The frontlistiest ISBN returned in sales-dispay is not correct when applying sort=frontlistiest_onsale
• [RHAPI-842] - [UK] ISTCA search view not testing correct contrib role code for UK authors

New Feature

• [RHAPI-839] - Add awardDesc and awardLevel filter parameters

Task

• [RHAPI-821] - Update ignoreDivisionCode clause in siteFilter=CommonReads
• [RHAPI-822] - Remove ignoreDivisionCode clause from siteFilter=Retail
• [RHAPI-823] - Add acmartflap (AcMart book copy) to /views/product-display
• [RHAPI-824] - Add acmartflap (AcMart book copy) to /search/views/search-display
• [RHAPI-828] - Add categories zoom to /works/views/sales-display
• [RHAPI-831] - Expose Australia data via API
• [RHAPI-835] - Change recommend-from-simile to be able to use 3 dimensions

On Friday November 17, 2017, version 1.3.8 of the Enhanced PRH API was released to production. If you encounter any problems with your applications as a result of these changes, please contact us at api@penguinrandomhouse.com.

Version 1.3.8 release notes

This release has an update to the Title object as well as a new endpoint for generating category hierarchies that performs better than the original.

Publisher element

The endpoint /titles now generates objects that contain a new code/description pair named publisher.

/domains/PRH.US/titles/9780143107453

"publisher":{"code":"6262","description":"Penguin Publishing Group"}

New category hierarchy endpoint

The original category hierarchy has always been a sore point. It was designed for a very particular business need and thus never performed well as a general purpose hierarchy representation. I had in mind an idea to rewrite it to improve performance but I was concerned with breaking backwards compatability so in the end I just rolled a completely new endpoint: /categories/views/hierarchy-alt.

/domains/PRH.US/categories/views/hierarchy-alt?catSetId=CN&depth=2

{
  "recordCount": 10,
  "startTimestamp": "2017-11-17T19:00:32Z",
  "endTimestamp": "2017-11-17T19:00:32Z",
  "timeTaken": 10,
  "data": {
    "categories": [
      {
        "catId": 2000000000,
        "catDesc": "Consumer Category",
        "catUri": null,
        "menuText": null,
        "leafNode": false,
        "titleCount": null,
        "children": [
          {
            "catId": 2000000169,
            "catDesc": "Audiobooks",
            "catUri": "\/audiobooks",
            "menuText": "Audiobooks",
            "leafNode": true,
            "titleCount": null,
            "children": [
              
            ],
            "parent": null,
            "_embeds": null,
            "_links": [
              {
                "rel": "self",
                "href": "http:\/\/api.penguinrandomhouse.com\/resources\/v2\/title\/domains\/PRH.US\/categories\/2000000169",
                "method": "GET",
                "parameters": null
              }
            ]
          },

Either you need to supply a catSetId (starting at the top of the hierarchy) or a specific catId or catUri to identify an anchor category. Then you may specify the depth to restrict the number of levels that are returned (depth=1 just returns the category you specified; depth=2 returns your category and its children). There is also an optional siteFilter and countTitles parameter that the sales sites need to support their menuing system.

The advantages of this endpoint over /categories/views/hierarchy are primarily in the performance. That original view was built recursively and so for larger hierarchies can generate a lot of queries. This new one fetches all the IDs for a particular layer at a time and then looks up all the metadata at the end so it performs much better for fetching the full tree. I also like that it has links which makes it easier to browse.

New Feature

• [RHAPI-789] - Expose publisher name as part of Title representation

Task

• [RHAPI-698] - Improve performance of /categories/views/hierarchy
• [RHAPI-807] - Sales Platform | Create a site-specific title count in /categories/views/hierarchy
• [RHAPI-819] - Create siteFilter for Higher Education

Sub-Task

• [RHAPI-806] - Add Publisher to Title representation

On Wednesday November 8, 2017, version 1.3.7 of the Enhanced PRH API was released to production. If you encounter any problems with your applications as a result of these changes, please contact us at api@penguinrandomhouse.com.

Version 1.3.7 release notes

This is a minor release with changes to Chatbot and PRH United specific endpoints to support some bug fixes for those apps.

Bug

• [RHAPI-808] - The /recommmend-from-category endpoint returns ISBNs that do not match all the supplied filter criteria

Task

• [RHAPI-809] - Change /recommend-from-simile to take a list of binary16
• [RHAPI-810] - Add authorid to IstcaWork

On Thursday November 2, 2017, version 1.3.6 of the Enhanced PRH API was released to production. If you encounter any problems with your applications as a result of these changes, please contact us at api@penguinrandomhouse.com.

Version 1.3.6 release notes

The major change with this version is a configuration change to point to a new version of Solr that services all of the text searches. As a result, some bugs were opened and addressed relating to testing search functions against this new instance. In some cases that resulted in some code changes or in configuration changes to the new instance. The goal with this migration is to have the /search and /search/predictive endpoints behave exactly the same as they did in version 1.3.5 and earlier.

The one exception to this relates to quality of predicitive results where we found a Solr configuration issue that was leading to lower quality results getting mixed in for certain terms. This issue was present in our earlier version as well but the fix was such a clear improvement that we decided that it was a good candidate to fix with this release and not to wait for the next version.

Bug

• [RHAPI-768] - The also-in author view should not return matches on the author "Various"
• [RHAPI-801] - Search for 'Dan Brown' does not return enough of his titles in first 10 results
• [RHAPI-804] - Predictive search returning different results under Solr 6

Task

• [RHAPI-799] - Change configuration to point at new Solr instance

Sub-Task

• [RHAPI-802] - Searches with 'the' in the query return non-exact matches above exact matches

On Thursday October 19, 2017, version 1.3.5 of the Enhanced PRH API was released to production. If you encounter any problems with your applications as a result of these changes, please contact us at api@penguinrandomhouse.com.

Version 1.3.5 release notes

This version fixes a bug with the /titles endpoint regarding the coverColor parameter for the Sales websites. It also adds some features to the /recommend-from-category view for the Chatbot app.

Bug

• [RHAPI-779] - Specifying coverColor parameter should trigger DISTINCT keyword for /titles

New Feature

• [RHAPI-791] - modify /works/views/recommend-from-category to accommodate listing author's works

On Wednesday September 5, 2017, version 1.3.2 of the Enhanced PRH API was released to production. If you encounter any problems with your applications as a result of these changes, please contact us at api@penguinrandomhouse.com.

Version 1.3.2 release notes

This version fixes a bug with a view being used by the PRH United app, /works/views/prhunited-match. It also adds the divisionCode filter parameter to the /works/{workId}/views/also-in/author view which kids needed to restrict the works being returned to just division 72.

Bug

• [RHAPI-763] - PRH United suggested view generating regex errors

New Feature

• [RHAPI-757] - Add divisionCode parameter support to also-in/author view

On Wednesday August 23, 2017, version 1.3.1 of the Enhanced PRH API was released to production. If you encounter any problems with your applications as a result of these changes, please contact us at api@penguinrandomhouse.com.

Version 1.3.1 release notes

Two minor bugs were fixed, both related to paging params start and rows, one related to the new sales display Work view and the other to the generation of links. In addition, some new features were added to support the ChatBot application.

Bug

• [RHAPI-745] - Paging issue with sales display view
• [RHAPI-758] - Exclude paging params from links

New Feature

• [RHAPI-750] - Create endpoint to support suggested match driver query
• [RHAPI-751] - Create endpoint to support suggested match lookup
• [RHAPI-761] - Add work view /recommend-from-category for ChatBot

On Thursday July 27, 2017, version 1.3.0 of the Enhanced PRH API was released to production. If you encounter any problems with your applications as a result of these changes, please contact us at api@penguinrandomhouse.com.

Version 1.3.0 release notes

This release was given a minor version increment from 1.2.x to 1.3 because core code was refactored to use a newly developed library that provides common RESTful API functionality to a number of PRH apps.

In addition, this release includes a small bug fix where the sales display view was sometimes returning an HTTP 500 when no records were found.

Finally, a new element originalIsbn was added to the Title representation.

/domains/PRH.US/titles/9780307959638

        "editionId": 0,
        "originalIsbn": "9780307959621",
        "otherFields": {},
        "_embeds": null,
        "_links": [

Bug

• [RHAPI-717] - sales-display view with series code and siteFilter parameters returns an error

New Feature

• [RHAPI-729] - Make Original ISBN available in Title data

Task

• [RHAPI-731] - Refactor to use RestTemplate Java library