Uploaded image for project: 'mod-inventory'
  1. mod-inventory
  2. MODINV-122

ISBN normalization API

    XMLWordPrintable

Details

    • ACQ Sprint 66, ACQ Sprint 67, ACQ Sprint 68
    • 3
    • Thunderjet

    Description

      Overview

      In order to facilitate the use of normalized ISBNs, particularly in search queries, an API is needed.

      It was determined that mod-inventory is a reasonable place for this API to live since it's a core module and "will always be there". That said, it should be easy to move later if desired since this API will define a new interface (see below)

      Approach

      The API should be defined under a new interface "isbn-utils".

      The folio-isbn-util shared library already exists and does most of the work, so we just need to create the API and call the util.

      API

      The API consists of 4 endpoints; two for performing isbn conversions and two for validating ISBNs w/o modification. The conversion endpoints support an optional query arg which allows you to add hyphens (defaults to false).

      GET /isbn/convertTo13?isbn=<10 or 13 isbn>&hyphens=<true|false> -> 200 or 400
GET /isbn/convertTo10?isbn=<10 or 13 isbn>&hyphens=<true|false> -> 200 or 400
GET /isbn/validator?isbn=<10 or 13 isbn> -> 200
GET /isbn/validator?isbn10=<10 isbn> -> 200
GET /isbn/validator?isbn13=<13 isbn> -> 200

      Responses/Schemas

      Validator Endpoints

      • Always return a 200. The response body is json response of true or false.

      ConvertTo* Endpoints

      • Return a 200 on success. The response body is a json object containing the converted isbn: 
        {
  "isbn": "9788675309000"
}
      • Return a 400 when an invalid ISBNs is provided. The response body should be an error json response indicating the problem.

      Acceptance Criteria

      • Schemas, RAML and Module Descriptors have been created/updated
      • Unit tests are updated

      TestRail: Results

        Attachments

          Issue Links

            relates to

            Bug - A problem which impairs or prevents the functions of the product. MODINV-139 400/422 error reporting of ISBN normalization API

            • P3 - low priority level, item will be considered for inclusion in the next dev cycle
            • Closed

            Story - Created by Jira Software - do not edit or delete. Issue type for a user story. MSEARCH-307 BE - Normalize ISBNs for ISBN searching. Search option: Identifier (all) in the Instance segment

            • P3 - low priority level, item will be considered for inclusion in the next dev cycle
            • Closed

            Story - Created by Jira Software - do not edit or delete. Issue type for a user story. UIIN-647 Normalize ISBNs for ISBN searching in Instance, holdings, item segments. New search option: ISBN, normalized

            • P3 - low priority level, item will be considered for inclusion in the next dev cycle
            • Closed

            Story - Created by Jira Software - do not edit or delete. Issue type for a user story. UIIN-998 Normalize ISBNs for ISBN searching. Search option: Keyword (Instance, Holdings, Item)

            • P3 - low priority level, item will be considered for inclusion in the next dev cycle
            • Closed

            Story - Created by Jira Software - do not edit or delete. Issue type for a user story. UIIN-999 Normalize ISBNs for ISBN searching. Search option: Identifier (all) in the Instance segment

            • P3 - low priority level, item will be considered for inclusion in the next dev cycle
            • Closed

            Story - Created by Jira Software - do not edit or delete. Issue type for a user story. UIOR-274 Normalize ISBNs for ISBN Product ID searching in Order lines

            • P2 - normal priority level, must be included in the current development cycle
            • Closed

            Story - Created by Jira Software - do not edit or delete. Issue type for a user story. UIOR-297 Refine the product ID search by ISSN and ISBN for POLs

            • P3 - low priority level, item will be considered for inclusion in the next dev cycle
            • In Refinement

            Story - Created by Jira Software - do not edit or delete. Issue type for a user story. UIOR-332 Add validation to POL product id field if product id type is isbn

            • P3 - low priority level, item will be considered for inclusion in the next dev cycle
            • Closed

            Story - Created by Jira Software - do not edit or delete. Issue type for a user story. UIOR-392 Move ISBN Qualifier to separate field in UI Create/Edit screen

            • P2 - normal priority level, must be included in the current development cycle
            • Closed

            Story - Created by Jira Software - do not edit or delete. Issue type for a user story. UIOR-393 Change UI for POL Contributor and Product ID fields to grid format and add Qualifier

            • P3 - low priority level, item will be considered for inclusion in the next dev cycle
            • Closed

            New Feature - New feature requests UXPROD-1685 Search by normalized ISBN number - in Inventory (thin thread, dedicated search option)

            • P3 - low priority level, item will be considered for inclusion in the next dev cycle
            • Closed

            New Feature - New feature requests UXPROD-2323 Search by normalized ISBN number - in Inventory (phase 2, use ISBN as general Search option)

            • P3 - low priority level, item will be considered for inclusion in the next dev cycle
            • Closed

            Activity

              People

                KVupp Kruthi Vuppala
                cmcnally Craig McNally
                Craig McNally Craig McNally
                Votes:
                0 Vote for this issue
                Watchers:
                9 Start watching this issue

                Dates

                  Created:
                  Updated:
                  Resolved:

                  TestRail: Runs

                    TestRail: Cases