Purpose of this document

It needs to be decided which module "automated patron blocks" functionality has to be implemented in. There are few options:

• mod-circulation (Approach 1)

• new "automated blocks" module (mod-automated-blocks)

  • fetching data from mod-circulation (circular dependency)

  • fetching data from mod-circulation-storage

  • consuming events published by mod-circulation

    • mod-circulation requests block from mod-automated-blocks (Approach 2)
    • mod-automated-blocks publishes block events

Overview

It is required for a number of modules (both BE and FE) to be able to check if a patron should be blocked from borrowing, renewing and/or requesting items and why. mod-circulation should check for these blocks every time one of these actions is performed. Also, we need to provide an endpoint (at least for UI modules, see UIU-1273) for checking patron block conditions. Each of these condition checks has a dependency on functionality implemented in various modules:

Approach 1 (mod-circulation)

API

Even though most of the checks will be happening internally in mod-circulation, other modules (UIU-1273) will need to use this functionality to display existing patron blocks to the user, so it is proposed to add a new endpoint:

GET /automated-patron-blocks/{patronId}

Response example:

{
  "automatedPatronBlocks": [
    {
      "blockBorrowing": true,
      "blockRenewal": false,
      "blockRequest": false,
      "message": "Patron has reached maximum allowed number of items charged out"
    },
    {
      "blockBorrowing": false,
      "blockRenewal": false,
      "blockRequest": true,
      "message": "Patron has reached maximum allowed outstanding fee/fine balance for his/her patron group"
    }
  ]
}

Dependencies

No new dependencies are required in mod-circulation for Approach 1.

/patron-block-condition

/patron-block-limits?query=(patronGroupId=={patronGroupId})

/accounts?query=(userId=={patronId} AND status=="Open")

/calendar/periods

Approach 2 (new module; pub-sub)

New module (mod-automated-blocks) will be created. It will receive info about circulation events and fees/fines from event subscriptions.

Publishing/subscriptions configuration

{
  "feeFineId": string,
  "userId": string,
  "balance": numeric,
  "feeFineTypeId": string
}

Example:
{
  "feeFineId": "82d804b9-8a73-4d9d-bf9b-78f751758420",
  "userId": "4f0e711c-d583-41e0-9555-b62f1725023f",
  "balance": 15.45,
  "feeFineTypeId": "95df458a-5a01-4f9a-99e1-64d5657d8379"
}

{
  "userId": string,
  "loanId": string,
  "dueDate": string
}

{
  "userId": string,
  "loanId": string,
  "returnDate": string
}

{
  "userId": string,
  "loanId": string
}

{
  "userId": string,
  "loanId": string,
  "dueDate": string,
  "dueDateChangedByRecall": boolean
}

DB

Using the info from events mod-automated-blocks is subscribed to, we need to maintain one object per patron in the DB:

{
  "id": string,
  "userId": string,
  "outstandingFeeFineBalance": numeric,
  "numberOfLostItems": numeric,
  "openLoans": [
    {
      "loanId": string,
      "dueDate": string,
      "returnedDate": string,
      "recall": boolean
    }
  ],
  "openFeesFines": [
    {
      "feeFineId": string,
      "balance": numeric,
      "feeFineTypeId": string
    }
  ]
}

This object allows to check each of the block conditions for a patron:

API

GET /automated-patron-blocks/{patronId}

Other modules will use this endpoint to determine if patron should be blocked from borrowing, renewing and/or requesting items and why.

Response example:

{
  "automatedPatronBlocks": [
    {
      "patronBlockConditionId": "2149fff5-a64c-4943-aa79-bb1d09511382",
      "blockBorrowing": true,
      "blockRenewal": false,
      "blockRequest": false,
      "message": "Patron has reached maximum allowed number of items charged out"
    },
    {
      "patronBlockConditionId": "ac13a725-b25f-48fa-84a6-4af021d13afe",
      "blockBorrowing": false,
      "blockRenewal": false,
      "blockRequest": true,
      "message": "Patron has reached maximum allowed outstanding fee/fine balance for his/her patron group"
    }
  ]
}

GET /patron-block-condition
GET /patron-block-conditions/{patronBlockConditionId}
PUT /patron-block-conditions/{patronBlockConditionId}
GET /patron-block-limits
POST /patron-block-limits
GET /patron-block-limits/{patronBlockLimitId}
PUT /patron-block-limits/{patronBlockLimitId}
DELETE /patron-block-limits/{patronBlockLimitId}

These endpoints will be moved from mod-users. This allows to avoid mod-automated-blocks dependency on mod-users.

Dependencies

GET /automated-patron-blocks/{patronId}

GET /users/{id}