Interactions with EDGE modules for FOLIO integration

Assumptions

  • All consortia member libraries will be on the same cluster

  • Each member library of the consortia will get their own edge endpoint and key

  • Consortia functionality is triggered when targeting the central tenant edge endpoint. What that functionality is really depends on what the module wants to do.

  • Tenant specific key MUST be used when hitting the Member Library Endpoint

Module

Tenant Resolution

Consumers

Member Library Endpoint

DCB Endpoint Usage

Central Tenant Endpoint

Module

Tenant Resolution

Consumers

Member Library Endpoint

DCB Endpoint Usage

Central Tenant Endpoint

edge-dcb

API Key

  • DCB

  • DCB transactions are ALWAYS targeted towards a member library

  • Manage DCB transactions

  • Place requests - POST /transactions/{id}

  • Reaction to state changes in other systems - PUT /transactions/{id}

  • Detection of state change - GET /transactions/{id}

N/A

edge-oai-pmh

API Key

  • DCB

  • Harvest data for a single member library

  • Ingest - GET /oai

  • When invoked with central tenant key, federated harvesting is triggered

  • When invoked with member library key, harvesting specific to that member library is triggered

edge-patron

API Key

  • Local Locate

  • Local Locate

    • Get patron account

    • Place/Cancel Hold

    • Renew Loan

 

N/A

edge-inventory

API Key

  • Local Locate

 

 

N/A

edge-users

API Key

  • Local Locate

  • DCB

  • DCB - Validate patron

  • Validate patron

    • Check if the patron exists

    • Barcode/Pin validation

    • Good Standing - TBD

N/A

edge-rtac

API Key

  • Local Locate

  • DCB

  • DCB - Live availability

  • Local Locate - To display RTAC in the instance detail page

  • Live availability - GET /rtac?instanceIds={instanceId}&fullPeriodicals=true

N/A

 

Operated as a Community Resource by the Open Library Foundation