Borrower Renew ItemRefer to https://docs.google.com/spreadsheets/d/1YHi1e3F43WBvP2LzCl2HnEAH7-t0TEs6RIvWKvFkrZQ/edit#gid=0 for more details.
| Implementation Status | Endpoint | Brief description | HTTP Method | Central or Local Server | Group | Jira Reference |
|---|---|---|---|---|---|---|
| auth/v1/oauth2/token | Inn-Reach authentication | POST | Central | Authentication |  |
| TBD | Third-party authentication | POST | Local | Authentication | EDGINREACH-2 - Getting issue details... STATUS |
| /innreach/v2/location/<locationKey> | Upload a Single Location | PUT | Central | Configuration | ||
| /innreach/v2/location/<locationKey> | Update a Single Location | POST | Central | Configuration | ||
| /innreach/v2/location/<locationKey> | Delete a Single Location | DELETE | Central | Configuration | ||
| /innreach/v2/contribution/locations | Upload Locations List | POST | Central | Configuration | ||
| /innreach/v2/contribution/locations | Retrieve Locations List | GET | Central | Configuration | ||
| /innreach/v2/contribution/localservers | Get Local Servers | GET | Central | Configuration | ||
| /innreach/v2/contribution/itemtypes | Get Central Item Types | GET | Central | Configuration | ||
| /innreach/v2/circ/patrontypes | Get Central Patron Types | GET | Central | Configuration | MODINREACH-77 - Getting issue details... STATUS | |
| /innreach/v2/contribution/bib/<bibId> | Contribute Bib | POST | Central | Contribution | ||
| /innreach/v2/contribution/items/<bibId> | Contribute Batch Items | POST | Central | Contribution | ||
| /innreach/v2/contribution/bibstatus/<bibId> | Update Bib Status | POST | Central | Contribution | ||
| /innreach/v2/contribution/itemstatus/<itemId> | Update Item Status | POST | Central | Contribution | ||
| /innreach/v2/local/<localCode>/bib/<bibId> | Look Up Bib by bibId | GET | Central | Contribution | ||
| /innreach/v2/local/<localCode>/bib/<bibId>/item/<itemId> | Look Up Bib by bibId and itemId | GET | Central | Contribution | ||
| /innreach/v2/base64encoding | Get Base64 Encoding Table | GET | Central | Contribution | ||
| /innreach/v2/contribution/item/<itemId> | Decontribute Item | DELETE | Central | Contribution | ||
| /innreach/v2/contribution/bib/<bibId> | Decontribute Bib | DELETE | Central | Contribution | ||
| /innreach/v2/circ/borrowerrenew/<trackingId>/<centralCode> | Borrower Renew Item | POST | Central | Circulation | ||
| /innreach/v2/circ/cancelitemhold/<trackingId>/<centralCode> | Cancel Item Hold | POST | Central | Circulation | ||
| /innreach/v2/circ/finalcheckin/<trackingId>/<centralCode> | Final Item Check-In | POST | Central | Circulation | ||
| /innreach/v2/circ/intransit/<trackingId>/<centralCode> | Item In Transit | POST | Central | Circulation | ||
| /innreach/v2/circ/itemshipped/<trackingId>/<centralCode> | Item Shipped | POST | Central | Circulation | ||
| /innreach/v2/circ/localcheckout/<trackingId>/<centralCode> | Local Checkout | POST | Central | Circulation | ||
| /innreach/v2/circ/ownerrenew/<trackingId>/<centralCode> | Owner Renew Item | POST | Central | Circulation | ||
| /innreach/v2/circ/owningsitecancel/<trackingId>/<centralCode> | Owning Site Cancels Request | POST | Central | Circulation | ||
| /innreach/v2/circ/claimsreturned/<trackingId>/<centralCode> | Patron Claims Returned | POST | Central | Circulation | ||
| /innreach/v2/circ/recall/<trackingId>/<centralCode> | Recall Item | POST | Central | Circulation | ||
| /innreach/v2/circ/itemreceived/<trackingId>/<centralCode> | Report Item Received | POST | Central | Circulation | ||
| /innreach/v2/circ/receiveunshipped/<trackingId>/<centralCode> | Report Unshipped Item Received | POST | Central | Circulation | ||
| /innreach/v2/circ/returnuncirculated/<trackingId>/<centralCode> | Return Uncirculated Item | POST | Central | Circulation | ||
| /innreach/v2/circ/transferrequest/<trackingId>/<centralCode> | Transfer Request | POST | Central | Circulation | ||
| /innreach/v2/circ/borrowerrenew/<trackingId>/<centralCode> | Borrower Renew Item | PUT | Local | Circulation | MODINREACH-100 - Getting issue details... STATUS | |
| /innreach/v2/circ/cancelitemhold/<trackingId>/<centralCode> | Cancel Item Hold | PUT | Local | Circulation | MODINREACH-90 - Getting issue details... STATUS | |
| /innreach/v2/circ/cancelrequest/<trackingId>/<centralCode> | Cancel Request | PUT | Local | Circulation | MODINREACH-88 - Getting issue details... STATUS | |
| /innreach/v2/circ/itemhold/<trackingId>/<centralCode> | Create Item Hold | POST | Local | Circulation | MODINREACH-83 - Getting issue details... STATUS MODINREACH-91 - Getting issue details... STATUS | |
| /innreach/v2/circ/localhold/<trackingId>/<centralCode> | Create Local Hold | PUT | Local | Circulation | MODINREACH-89 - Getting issue details... STATUS MODINREACH-93 - Getting issue details... STATUS | |
| /innreach/v2/circ/patronhold/<trackingId>/<centralCode> | Create Patron Hold | POST | Local | Circulation | MODINREACH-85 - Getting issue details... STATUS MODINREACH-92 - Getting issue details... STATUS | |
| /innreach/v2/circ/finalcheckin/<trackingId>/<centralCode> | Final Item Check-In | PUT | Local | Circulation | MODINREACH-102 - Getting issue details... STATUS | |
| /innreach/v2/circ/intransit/<trackingId>/<centralCode> | Item In Transit | PUT | Local | Circulation | MODINREACH-103 - Getting issue details... STATUS | |
| /innreach/v2/circ/itemshipped/<trackingId>/<centralCode> | Item Shipped | PUT | Local | Circulation | MODINREACH-87 - Getting issue details... STATUS | |
| /innreach/v2/circ/ownerrenew/<trackingId>/<centralCode> | Owner Renew Item | PUT | Local | Circulation | MODINREACH-104 - Getting issue details... STATUS | |
| /innreach/v2/circ/claimsreturned/<trackingId>/<centralCode> | Patron Claims Returned | PUT | Local | Circulation | ||
| /innreach/v2/circ/recall/<trackingId>/<centralCode> | Recall Item | PUT | Local | Circulation | MODINREACH-99 - Getting issue details... STATUS | |
| /innreach/v2/circ/itemreceived/<trackingId>/<centralCode> | Report Item Received | PUT | Local | Circulation | MODINREACH-96 - Getting issue details... STATUS | |
| /innreach/v2/circ/receiveunshipped/<trackingId>/<centralCode> | Report Unshipped Item Received | PUT | Local | Circulation | MODINREACH-97 - Getting issue details... STATUS | |
| /innreach/v2/circ/returnuncirculated/<trackingId>/<centralCode> | Return Uncirculated Item | PUT | Local | Circulation | MODINREACH-98 - Getting issue details... STATUS | |
| /innreach/v2/circ/transferrequest/<trackingId>/<centralCode> | Transfer Request | PUT | Local | Circulation | MODINREACH-86 - Getting issue details... STATUS | |
| /innreach/v2/circ/verifypatron | Verify Patron | POST | Local | Circulation | MODINREACH-21 - Getting issue details... STATUS EDGINREACH-1 - Getting issue details... STATUS | |
| /innreach/v2/getbibrecord/<bibId>/<centralCode> | Get Bib Record | POST | Local | Circulation | ||
| /innreach/v2/status | Get Status | GET | Local | Circulation | EDGINREACH-7 - Getting issue details... STATUS |
2 Comments
Oleksandr Yatsenko
As for "get Status" endpoint, I saw it was mentioned in D2IR API Specification with this "v2" mentioned in path. Does it mean that there is "v1" variety already exists and we need to consider this route as version 2 of API in our implementation? I mean should we be connected semantically to version signification when implementing our stack of API, or we can start to define all the API (including this one) as version 1.0 ? Because version mentioning in routes slightly confusing, thanks.
Raman Auramau
Thank you for asking Oleksandr.
We have to follow D2IR specification while implementing those endpoints which are to be provided by Folio aka Local Server, so v2 is to be there in edge-inn-reach as an external API.
At the same time, internal API endpoints (i.e. provided by mod-inn-reach on Folio platform) are not related to D2IR specification; the Volaris team creates, owns and manages this internal API, so it makes sense to start versioning with v1.
Agree that this might be a bit confusing from the first glance but this should be more logical eventually.