Versions Compared

Key

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

...

Module

Publish/subscribe

Event type

Payload

mod-feesfines

publish

FF_BALANCE_CHANGED

{
"accountIdfeeFineId": string,
  "userId": string,
  "balance": numeric,
"feeFineIdfeeFineTypeId": string
}

Example:
{
"accountIdfeeFineId": "82d804b9-8a73-4d9d-bf9b-78f751758420",
  "userId": "4f0e711c-d583-41e0-9555-b62f1725023f",
  "balance": 15,
"feeFineIdfeeFineTypeId": "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_UPDATED
{
  "userId": string,
  "loanId": string,
  "dueDate": string,
"recall": boolean
}
mod-automatedblockssubscribe

FF_BALANCE_CHANGED
ITEM_CHECKED_OUT
ITEM_CHECKED_IN
ITEM_DECLARED_LOST
LOAN_DUE_DATE_UPDATED


...

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

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

...