Add Support for D2IR API Integration with INN-Reach Resource Sharing Systems (UXPROD-2598)

[UXPROD-2711] Implement Required Local Requests-related Local API Endpoints for D2IR (INN-Reach) Local Servers in FOLIO Created: 01/Oct/20  Updated: 30/Jan/22  Resolved: 30/Jan/22

Status: Closed
Project: UX Product
Components: None
Affects versions: None
Fix versions: Lotus (R1 2022)
Parent: Add Support for D2IR API Integration with INN-Reach Resource Sharing Systems

Type: New Feature Priority: TBD
Reporter: Brooks Travis Assignee: Brooks Travis
Resolution: Done Votes: 0
Labels: consortia, d2ir-api
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original estimate: Not Specified

Issue links:
Defines
is defined by MODINREACH-170 INN-Reach Settings: Store INN-Reach R... Closed
is defined by MODINREACH-171 INN-Reach Settings: API Endpoint(s) f... Closed
is defined by MODINREACH-194 D2IR Local Endpoint (Circulation): Ch... Closed
is defined by MODINREACH-197 D2IR Local Endpoint (Circulation): Fi... Closed
is defined by UIINREACH-110 INN Reach Settings: Configure INN-Rea... Closed
is defined by MODINREACH-99 D2IR Local Endpoint (Circulation): Re... Closed
is defined by UIINREACH-117 INN-Reach Settings: Permissions - Add... Closed
is defined by EDGINREACH-1 D2IR Local Endpoint (Circulation): Re... Closed
is defined by MODINREACH-21 D2IR Local Endpoint (Circulation): Pa... Closed
is defined by MODINREACH-61 INN-Reach Circulation Settings: Centr... Closed
is defined by MODINREACH-62 INN-Reach Circulation Settings: Creat... Closed
is defined by MODINREACH-63 INN-Reach Circulation Settings: Creat... Closed
is defined by MODINREACH-83 D2IR Local Endpoint (Circulation): Cr... Closed
is defined by MODINREACH-85 D2IR Local Endpoint (Circulation): Cr... Closed
is defined by MODINREACH-86 D2IR Local Endpoint (Circulation): Tr... Closed
is defined by MODINREACH-87 D2IR Local Endpoint (Circulation): It... Closed
is defined by MODINREACH-88 D2IR Local Endpoint (Circulation): Ca... Closed
is defined by MODINREACH-89 D2IR Local Endpoint (Circulation): Cr... Closed
is defined by MODINREACH-90 D2IR Local Endpoint (Circulation): Ca... Closed
is defined by MODINREACH-91 D2IR Local Endpoint (Circulation): Cr... Closed
is defined by MODINREACH-92 D2IR Local Endpoint (Circulation): Cr... Closed
is defined by MODINREACH-93 D2IR Local Endpoint (Circulation): Cr... Closed
is defined by MODINREACH-96 D2IR Local Endpoint (Circulation): Re... Closed
is defined by MODINREACH-97 D2IR Local Endpoint (Circulation): Re... Closed
is defined by MODINREACH-98 D2IR Local Endpoint (Circulation): Re... Closed
is defined by UIINREACH-125 BE integration for 'INN-Reach Recall ... Closed
is defined by MODINREACH-4 INN-Reach: Create Local Instance, Hol... Closed
is defined by MODINREACH-156 Introduce changes to data model of pa... Closed
Requires
requires UXPROD-2672 Implement "Third Party" OAuth2 Token ... Closed
Epic Link: Add Support for D2IR API Integration with INN-Reach Resource Sharing Systems
Front End Estimate: Out of scope
Back End Estimate: XXXL: 30-45 days
Development Team: Volaris
Kiwi Planning Points (DO NOT CHANGE): 2
PO Rank: 90
Rank: Chicago (MVP Sum 2020): R5
Rank: Cornell (Full Sum 2021): R5
Rank: Duke (Full Sum 2021): R5
Rank: 5Colleges (Full Jul 2021): R5
Rank: GBV (MVP Sum 2020): R5
Rank: Grand Valley (Full Sum 2021): R2
Rank: MO State (MVP June 2020): R2
Rank: TAMU (MVP Jan 2021): R5
Rank: U of AL (MVP Oct 2020): 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 Closed ):

Verify Patron

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

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



 Comments   
Comment by Brooks Travis [ 30/Jan/22 ]

All stories complete

Generated at Fri Feb 09 00:26:13 UTC 2024 using Jira 1001.0.0-SNAPSHOT#100246-sha1:7a5c50119eb0633d306e14180817ddef5e80c75d.