Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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

...

Module

Publish/subscribe

Event type

Payload

mod-feesfines

publish

FFFEE_FINE_BALANCE_CHANGED

{
"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"
}
mod-circulationpublish

ITEM_CHECKED_OUT

{
  "userId": string,
  "loanId": string,
  "dueDate": string
}
mod-circulationpublishITEM_CHECKED_IN
{
  "userId": string,
"loanId": string,
"returnDate": string
}
mod-circulationpublishITEM_DECLARED_LOST
{
  "userId": string,
"loanId": string
}
mod-circulationpublishLOAN_DUE_DATE_CHANGED
{
  "userId": string,
  "loanId": string,
  "dueDate": string,
"dueDateChangedByRecall": boolean
}
mod-automatedblockssubscribe

FFFEE_FINE_BALANCE_CHANGED
ITEM_CHECKED_OUT
ITEM_CHECKED_IN
ITEM_DECLARED_LOST
LOAN_DUE_DATE_CHANGED


...

Code Block
languagejs
{
  "id": string,
  "userId": string,
  "outstandingFeeFineBalance": numeric,
  "numberOfOpenFeesFinesForLostItems": numeric,
  "numberOfLostItems": numeric,
  "openLoans": [
    {
      "loanId": string,
      "dueDate": string,
      "returnedDate": string,
      "recall": boolean
    }
  ],
  "openAccountsopenFeesFines": [
    {
      "feeFineId": string,
      "balance": numeric,
      "feeFineTypeId": string
    }
  ]
}

...

ConditionCheck against

Maximum outstanding fee/fine balance

.outstandingFeeFineBalance

Maximum number of items charged out

number of .openLoans objects

Maximum number of lost items

.numberOfOpenFeesFinesForLostItemsnumberOfLostItems

Maximum number of overdue items

number of .openLoans[dueDate < returnedDate]

Maximum number of overdue recalled items

number of .openLoans[dueDate < returnedDate AND recall == true]

Maximum number of overdue days for recalled item

max of .openLoans[dueDate < returnedDate AND recall == true].(returnedDate - dueDate)

...

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

...

ModuleEndpointPurpose
mod-circulation → mod-automated-blocks
GET /automated-patron-blocks/{patronId}
Check if action is allowed before borrowing, renewing and/or requesting items.

mod-automated-blocks → mod-users

GET /users/{id}
To determine which patron group a patron belongs to.