Uploaded image for project: 'UX Product'
  1. UX Product
  2. UXPROD-2711

Implement Required Local Requests-related Local API Endpoints for D2IR (INN-Reach) Local Servers in FOLIO

    XMLWordPrintable

Details

    • Out of scope
    • XXXL: 30-45 days
    • Volaris
    • 2
    • 90
    • R5
    • R5
    • R5
    • R5
    • R5
    • R2
    • R2
    • R5
    • R5

    Description

      Current situation or problem

      To support integration with an INN-Reach resource sharing system via the Direct to INN-Reach (D2IR) APIs, FOLIO must make the following HTTP endpoints available using Oauth2 Bearer tokens for authentication (UXPROD-2672):

      Verify Patron

      POST /innreach/v2/circ/verifypatron (EDGINREACH-1, MODINREACH-21)

      Create Patron Hold

      POST /innreach/v2/circ/patronhold/<trackingId>/<centralCode> (MODINREACH-85)

      Create Local Hold

      PUT /innreach/v2/circ/localhold/<trackingId>/<centralCode> (MODINREACH-89)

      Create Item Hold

      POST /innreach/v2/circ/itemhold/<trackingId>/<centralCode> (MODINREACH-83)

      Transfer Request

      PUT /innreach/v2/circ/transferrequest/<trackingId>/<centralCode> (MODINREACH-86)

      Cancel Item Hold

      PUT /innreach/v2/circ/cancelitemhold/<trackingId>/<centralCode> (MODINREACH-90)

      Cancel Request

      PUT /innreach/v2/circ/cancelrequest/<trackingId>/<centralCode> (MODINREACH-88)

      Item Shipped

      PUT /innreach/v2/circ/itemshipped/<trackingId>/<centralCode> (MODINREACH-87)

      Item Received

      PUT /innreach/v2/circ/itemreceived/<trackingId>/<centralCode> (MODINREACH-96)

      Report Unshipped Item Received

      PUT /innreach/v2/circ/receiveunshipped/<trackingId>/<centralCode> (MODINREACH-97)

      Return Uncirculated Item

      PUT /innreach/v2/circ/returnuncirculated/<trackingId>/<centralCode> (MODINREACH-98)

      Recall Item

      PUT /innreach/v2/circ/recall/<trackingId>/<centralCode> (MODINREACH-99)

      In scope

      Local Server Endpoints and the attendant functionality in FOLIO

      Out of scope

      FOLIO functionality that calls D2IR API endpoints on an INN-Reach central server

      Use case(s)

      These API endpoints are required to support Local Server functions in an INN-Reach resource sharing system.

      Proposed solution/stories

      And edge module that receives these API calls and passes them to an internal INN-Reach module for processing. Endpoints need to support versioning. Stories and requirements for each endpoint will be specified in separate tickets and linked back to this ticket.

      Links to Additional Info

      Google Sheet mapping D2IR APIs to FOLIO functionality

      Questions

      N/A

      TestRail: Results

        Attachments

          Issue Links

            is defined by

            Story - Created by Jira Software - do not edit or delete. Issue type for a user story. EDGINREACH-1 D2IR Local Endpoint (Circulation): Respond to Patron Verification Requests at /innreach/v2/circ/verifypatron

            • P4 - lowest priority level, nice-to have things that require future discussion and design
            • Closed

            Story - Created by Jira Software - do not edit or delete. Issue type for a user story. MODINREACH-4 INN-Reach: Create Local Instance, Holdings, and Item Records for Patron Hold

            • TBD - To be determined
            • Closed

            Story - Created by Jira Software - do not edit or delete. Issue type for a user story. MODINREACH-21 D2IR Local Endpoint (Circulation): Patron Verification Endpoint in mod-inn-reach

            • P4 - lowest priority level, nice-to have things that require future discussion and design
            • Closed

            Story - Created by Jira Software - do not edit or delete. Issue type for a user story. MODINREACH-61 INN-Reach Circulation Settings: Central Item Type to FOLIO Material Type Configuration for Patron Holds ("Virtual" item material type)

            • P4 - lowest priority level, nice-to have things that require future discussion and design
            • Closed

            Story - Created by Jira Software - do not edit or delete. Issue type for a user story. MODINREACH-62 INN-Reach Circulation Settings: Create CRUD APIs for Central Item Type to FOLIO Material Type Configuration for Patron Holds ("Virtual" item material type)

            • P4 - lowest priority level, nice-to have things that require future discussion and design
            • Closed

            Story - Created by Jira Software - do not edit or delete. Issue type for a user story. MODINREACH-63 INN-Reach Circulation Settings: Create Data Model to Store FOLIO Patron Group to INN-Reach Central Patron Type Mapping

            • P4 - lowest priority level, nice-to have things that require future discussion and design
            • Closed

            Story - Created by Jira Software - do not edit or delete. Issue type for a user story. MODINREACH-83 D2IR Local Endpoint (Circulation): Create INN-Reach Item Hold - Create Transaction

            • P4 - lowest priority level, nice-to have things that require future discussion and design
            • Closed

            Story - Created by Jira Software - do not edit or delete. Issue type for a user story. MODINREACH-85 D2IR Local Endpoint (Circulation): Create INN-Reach Patron Hold - Create Transaction

            • P4 - lowest priority level, nice-to have things that require future discussion and design
            • Closed

            Story - Created by Jira Software - do not edit or delete. Issue type for a user story. MODINREACH-86 D2IR Local Endpoint (Circulation): Transfer Request for INN-Reach Patron Hold

            • P4 - lowest priority level, nice-to have things that require future discussion and design
            • Closed

            Story - Created by Jira Software - do not edit or delete. Issue type for a user story. MODINREACH-87 D2IR Local Endpoint (Circulation): Item Shipped Request for INN-Reach Patron Hold

            • P4 - lowest priority level, nice-to have things that require future discussion and design
            • Closed

            Story - Created by Jira Software - do not edit or delete. Issue type for a user story. MODINREACH-88 D2IR Local Endpoint (Circulation): Cancel Request for INN-Reach Patron Hold

            • P4 - lowest priority level, nice-to have things that require future discussion and design
            • Closed

            Story - Created by Jira Software - do not edit or delete. Issue type for a user story. MODINREACH-89 D2IR Local Endpoint (Circulation): Create INN-Reach Local Hold - Create Transaction

            • P4 - lowest priority level, nice-to have things that require future discussion and design
            • Closed

            Story - Created by Jira Software - do not edit or delete. Issue type for a user story. MODINREACH-90 D2IR Local Endpoint (Circulation): Cancel Request for INN-Reach Item Hold

            • P4 - lowest priority level, nice-to have things that require future discussion and design
            • Closed

            Story - Created by Jira Software - do not edit or delete. Issue type for a user story. MODINREACH-91 D2IR Local Endpoint (Circulation): Create INN-Reach Item Hold - Create FOLIO Request

            • P4 - lowest priority level, nice-to have things that require future discussion and design
            • Closed

            Story - Created by Jira Software - do not edit or delete. Issue type for a user story. MODINREACH-92 D2IR Local Endpoint (Circulation): Create INN-Reach Patron Hold - Create FOLIO Inventory Instance, Holding and Item

            • P4 - lowest priority level, nice-to have things that require future discussion and design
            • Closed

            Story - Created by Jira Software - do not edit or delete. Issue type for a user story. MODINREACH-93 D2IR Local Endpoint (Circulation): Create INN-Reach Local Hold - Create FOLIO Request

            • P4 - lowest priority level, nice-to have things that require future discussion and design
            • Closed

            Story - Created by Jira Software - do not edit or delete. Issue type for a user story. MODINREACH-96 D2IR Local Endpoint (Circulation): Report Item Received to Owning Site for Item Hold

            • P4 - lowest priority level, nice-to have things that require future discussion and design
            • Closed

            Story - Created by Jira Software - do not edit or delete. Issue type for a user story. MODINREACH-97 D2IR Local Endpoint (Circulation): Report Unshipped Item Received to Owning Site for Item Hold

            • P4 - lowest priority level, nice-to have things that require future discussion and design
            • Closed

            Story - Created by Jira Software - do not edit or delete. Issue type for a user story. MODINREACH-98 D2IR Local Endpoint (Circulation): Return Uncirculated Message for Item Hold

            • P4 - lowest priority level, nice-to have things that require future discussion and design
            • Closed

            Story - Created by Jira Software - do not edit or delete. Issue type for a user story. MODINREACH-99 D2IR Local Endpoint (Circulation): Recall Item Message for Patron Hold

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

            Task - A task that needs to be done. MODINREACH-156 Introduce changes to data model of patron agency mapping

            • TBD - To be determined
            • Closed

            Story - Created by Jira Software - do not edit or delete. Issue type for a user story. MODINREACH-170 INN-Reach Settings: Store INN-Reach Recall User for Central Server

            • 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. MODINREACH-171 INN-Reach Settings: API Endpoint(s) for INN-Reach Recall User Setting

            • 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. MODINREACH-194 D2IR Local Endpoint (Circulation): Check Out Unshipped Item to Borrowing Site When Unshipped Item Received Reported Received to Owning Site for Item Hold

            • 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. MODINREACH-197 D2IR Local Endpoint (Circulation): Fix Item Shipped Request for INN-Reach Patron Hold API

            • 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. UIINREACH-110 INN Reach Settings: Configure INN-Reach Recall User Settings

            • 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. UIINREACH-117 INN-Reach Settings: Permissions - Add Recall Users Settings Permissions to "INN-Reach Settings: All permissions" Permission

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

            Task - A task that needs to be done. UIINREACH-125 BE integration for 'INN-Reach Recall User' setting

            • P4 - lowest priority level, nice-to have things that require future discussion and design
            • Closed
            requires

            New Feature - New feature requests UXPROD-2672 Implement "Third Party" OAuth2 Token Endpoint for D2IR (INN-Reach)

            • P1 - highest priority item, drop everything else before this is resolved, reserved for critical bugfixes
            • Closed

            Activity

              People

                brookstravis Brooks Travis
                brookstravis Brooks Travis
                Votes:
                0 Vote for this issue
                Watchers:
                2 Start watching this issue

                Dates

                  Created:
                  Updated:
                  Resolved:

                  TestRail: Runs

                    TestRail: Cases