foliolib.folio.api.circulation.CirculationEventHandlers

class foliolib.folio.api.circulation.CirculationEventHandlers(tenant: str, okapi: Optional[foliolib.okapi.okapiClient.OkapiClient] = None)

Bases: foliolib.folio.FolioApi

Circulation Event Handlers Endpoints

API to handle events

Parameters

tenant (str) – Tenant id
okapi (OkapiClient, optional) – Instance of OkapiClient. Defaults to None.

Methods

set_loanRelatedFeeFineClosed(...)

Handle fee/fine record with loan closed event

set_loanRelatedFeeFineClosed(loanRelatedFeeFineClosed: dict)

Handle fee/fine record with loan closed event

POST /circulation/handlers/loan-related-fee-fine-closed

Parameters: loanRelatedFeeFineClosed (dict) – See Schema below

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "description": "Fee/fine with loan is closed event",
  "properties": {
    "feeFineId": {
      "description": "Fee/fine id that was closed",
      "type": "string",
      "$ref": "../raml-util/schemas/uuid.schema"
    },
    "loanId": {
      "description": "Associated loan id",
      "type": "string",
      "$ref": "../raml-util/schemas/uuid.schema"
    }
  },
  "required": [
    "loanId"
  ]
}