Overdue Fine Policies (v1.1)

http://localhost:9130

Overdue Fine Policies API
/overdue-fines-policies

Overdue Fine Policies API

Overdue Fine Policies

/overdue-fines-policies

Collection of overdue-fines-policy items.

GET /overdue-fines-policies

Get Overdue Fine Policy list

GET /overdue-fines-policies

Query Parameters

query: (string)
A query expressed as a CQL string (see dev.folio.org/reference/glossary#cql) using valid searchable fields. The first example below shows the general form of a full CQL query, but those fields might not be relevant in this context.
searchable using CQL
Example:
```
(username=="ab*" or personal.firstName=="ab*" or personal.lastName=="ab*") and active=="true" sortby personal.lastName personal.firstName barcode

name="undergrad*"
```
orderBy: (string)
Order by field: field A, field B
order: (one of desc, asc - default: desc)
Order
totalRecords: (string - default: auto - pattern: exact|estimated|none|auto)
How to calculate the totalRecords property. "exact" for the correct number, "estimated" for an estimation, "auto" to automatically select "exact" or "estimated", "none" for suppressing the totalRecords property. For details see https://github.com/folio-org/raml-module-builder#estimated-totalrecords
Example:
```
none
```
offset: (integer - default: 0 - minimum: 0 - maximum: 2147483647)
Skip over a number of elements by specifying an offset value for the query
Example:
```
0
```
limit: (integer - default: 10 - minimum: 0 - maximum: 2147483647)
Limit the number of elements returned in the response. Using limit=0 will return totalRecords with the exact value. For details about totalRecords see https://github.com/folio-org/raml-module-builder#estimated-totalrecords
Example:
```
10
```

Response 200

Return Overdue Fine Policy list

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "Collection of overdue fine policies",
  "type": "object",
  "properties": {
    "overdueFinePolicies": {
      "description": "List of overdue fine policies",
      "id": "overdueFinePolicies",
      "type": "array",
      "items": {
        "type": "object",
        "$schema": "http://json-schema.org/draft-04/schema#",
        "title": "Overdue fine policies schema",
        "description": "Overdue fine policy to be associated with a loan policy by the Circulation Rules Editor",
        "properties": {
          "name": {
            "description": "Overdue fine policy name",
            "type": "string"
          },
          "description": {
            "description": "Overdue fine policy description",
            "type": "string"
          },
          "overdueFine": {
            "description": "Fine for overdue",
            "type": "object",
            "$schema": "http://json-schema.org/draft-04/schema#",
            "properties": {
              "quantity": {
                "description": "Fine amount per interval",
                "javaType": "org.folio.rest.domain.MonetaryValue",
                "type": "number"
              },
              "intervalId": {
                "description": "Interval for the period, e.g. hour, day, week, month or year",
                "type": "string",
                "enum": [
                  "minute",
                  "hour",
                  "day",
                  "week",
                  "month",
                  "year"
                ]
              }
            },
            "additionalProperties": false
          },
          "countClosed": {
            "description": "A flag to determine if a fine is count closed",
            "type": "boolean"
          },
          "maxOverdueFine": {
            "description": "Maximum overdue fine",
            "javaType": "org.folio.rest.domain.MonetaryValue",
            "type": "number"
          },
          "forgiveOverdueFine": {
            "description": "A flag to determine forgive overdue fine if item renewed",
            "type": "boolean"
          },
          "overdueRecallFine": {
            "description": "Fine overdue recall fine",
            "type": "object",
            "$schema": "http://json-schema.org/draft-04/schema#",
            "properties": {
              "quantity": {
                "description": "Fine amount per interval",
                "javaType": "org.folio.rest.domain.MonetaryValue",
                "type": "number"
              },
              "intervalId": {
                "description": "Interval for the period, e.g. hour, day, week, month or year",
                "type": "string",
                "enum": [
                  "minute",
                  "hour",
                  "day",
                  "week",
                  "month",
                  "year"
                ]
              }
            },
            "additionalProperties": false
          },
          "gracePeriodRecall": {
            "description": "Grace period for recall",
            "type": "boolean"
          },
          "maxOverdueRecallFine": {
            "description": "Maximum overdue recall fine",
            "javaType": "org.folio.rest.domain.MonetaryValue",
            "type": "number"
          },
          "reminderFeesPolicy": {
            "description": "Rules and schedule for reminders with associated fees",
            "type": "object",
            "$schema": "http://json-schema.org/draft-04/schema#",
            "title": "Reminder fees policy schema",
            "properties": {
              "countClosed": {
                "description": "A flag to determine if a reminder fee should take closed days into account",
                "type": "boolean"
              },
              "ignoreGracePeriodRecall": {
                "description": "Ignore grace period for recall",
                "type": "boolean"
              },
              "ignoreGracePeriodHolds": {
                "description": "Ignore grace period for holds",
                "type": "boolean"
              },
              "allowRenewalOfItemsWithReminderFees": {
                "description": "Allow renewal of items with reminder fee(s)",
                "type": "boolean"
              },
              "clearPatronBlockWhenPaid": {
                "description": "Clear patron block when paid",
                "type": "boolean"
              },
              "reminderSchedule": {
                "description": "Ordered list of reminder notices",
                "type": "array",
                "items": {
                  "description": "Scheduled reminder notice with associated fee",
                  "type": "object",
                  "properties": {
                    "interval": {
                      "description": "Number of units of time before notice should be sent",
                      "type": "integer"
                    },
                    "timeUnitId": {
                      "description": "Time unit of interval",
                      "type": "string",
                      "enum": [
                        "day",
                        "week",
                        "minute"
                      ]
                    },
                    "reminderFee": {
                      "description": "Fee amount accrued by reminder notice",
                      "javaType": "org.folio.rest.domain.MonetaryValue",
                      "type": "number"
                    },
                    "noticeFormat": {
                      "description": "Method of sending notice",
                      "type": "string",
                      "enum": [
                        "Email",
                        "Print",
                        "None"
                      ]
                    },
                    "noticeTemplateId": {
                      "description": "Id of reminder notice template",
                      "$schema": "http://json-schema.org/draft-04/schema#",
                      "id": "uuid.schema",
                      "type": "string",
                      "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
                    },
                    "blockTemplateId": {
                      "description": "Id of block reminder template",
                      "$schema": "http://json-schema.org/draft-04/schema#",
                      "id": "uuid.schema",
                      "type": "string",
                      "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
                    }
                  },
                  "additionalProperties": false,
                  "required": [
                    "interval",
                    "timeUnitId",
                    "reminderFee",
                    "noticeMethodId",
                    "noticeTemplateId"
                  ]
                }
              }
            },
            "additionalProperties": false
          },
          "metadata": {
            "description": "Metadata about creation to overdue fine policy, provided by the server",
            "type": "object",
            "$schema": "http://json-schema.org/draft-04/schema#",
            "id": "metadata.schema",
            "title": "Metadata Schema",
            "properties": {
              "createdDate": {
                "description": "Date and time when the record was created",
                "type": "string",
                "format": "date-time"
              },
              "createdByUserId": {
                "description": "ID of the user who created the record (when available)",
                "type": "string",
                "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
              },
              "createdByUsername": {
                "description": "Username of the user who created the record (when available)",
                "type": "string"
              },
              "updatedDate": {
                "description": "Date and time when the record was last updated",
                "type": "string",
                "format": "date-time"
              },
              "updatedByUserId": {
                "description": "ID of the user who last updated the record (when available)",
                "type": "string",
                "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
              },
              "updatedByUsername": {
                "description": "Username of the user who last updated the record (when available)",
                "type": "string"
              }
            },
            "additionalProperties": false,
            "required": [
              "createdDate"
            ]
          },
          "id": {
            "description": "Overdue fine policy id, UUID",
            "$schema": "http://json-schema.org/draft-04/schema#",
            "id": "uuid.schema",
            "type": "string",
            "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
          }
        },
        "additionalProperties": false,
        "required": [
          "name"
        ]
      }
    },
    "totalRecords": {
      "type": "integer"
    }
  },
  "required": [
    "overdueFinePolicies",
    "totalRecords"
  ]
}

Example:

{
  "overdueFinePolicies":[
    {
      "name": "Faculty standard",
      "description": "This is description for Faculty standard",
      "overdueFine": {
        "quantity": 5.0,
        "intervalId": "day"
       },
      "countClosed": true,
      "maxOverdueFine": 50.00,
      "forgiveOverdueFine": true,
      "overdueRecallFine": {
        "quantity": 1.0,
        "intervalId": "hour"
      },
      "gracePeriodRecall": false,
      "maxOverdueRecallFine": 50.00,
      "id": "b712dffc-c107-4e88-b3d5-fba2fb35755e" 
    }
  ],
  "totalRecords":1
}

Response 400

Bad request, e.g. malformed request body or query parameter. Details of the error (e.g. name of the parameter or line/character number with malformed data) provided in the response.

Body

Media type: text/plain

Type: any

Example:

unable to list overdue-fines-policies -- malformed parameter 'query', syntax error at column 6

Response 401

Not authorized to perform requested action

Body

Media type: text/plain

Type: any

Example:

unable to list overdue-fines-policies -- unauthorized

Response 500

Internal server error

Body

Media type: text/plain

Type: any

Example:

Internal server error

POST /overdue-fines-policies

Create new Overdue Fine Policy

POST /overdue-fines-policies

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Overdue fine policies schema",
  "description": "Overdue fine policy to be associated with a loan policy by the Circulation Rules Editor",
  "type": "object",
  "properties": {
    "name": {
      "description": "Overdue fine policy name",
      "type": "string"
    },
    "description": {
      "description": "Overdue fine policy description",
      "type": "string"
    },
    "overdueFine": {
      "description": "Fine for overdue",
      "type": "object",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "properties": {
        "quantity": {
          "description": "Fine amount per interval",
          "javaType": "org.folio.rest.domain.MonetaryValue",
          "type": "number"
        },
        "intervalId": {
          "description": "Interval for the period, e.g. hour, day, week, month or year",
          "type": "string",
          "enum": [
            "minute",
            "hour",
            "day",
            "week",
            "month",
            "year"
          ]
        }
      },
      "additionalProperties": false
    },
    "countClosed": {
      "description": "A flag to determine if a fine is count closed",
      "type": "boolean"
    },
    "maxOverdueFine": {
      "description": "Maximum overdue fine",
      "javaType": "org.folio.rest.domain.MonetaryValue",
      "type": "number"
    },
    "forgiveOverdueFine": {
      "description": "A flag to determine forgive overdue fine if item renewed",
      "type": "boolean"
    },
    "overdueRecallFine": {
      "description": "Fine overdue recall fine",
      "type": "object",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "properties": {
        "quantity": {
          "description": "Fine amount per interval",
          "javaType": "org.folio.rest.domain.MonetaryValue",
          "type": "number"
        },
        "intervalId": {
          "description": "Interval for the period, e.g. hour, day, week, month or year",
          "type": "string",
          "enum": [
            "minute",
            "hour",
            "day",
            "week",
            "month",
            "year"
          ]
        }
      },
      "additionalProperties": false
    },
    "gracePeriodRecall": {
      "description": "Grace period for recall",
      "type": "boolean"
    },
    "maxOverdueRecallFine": {
      "description": "Maximum overdue recall fine",
      "javaType": "org.folio.rest.domain.MonetaryValue",
      "type": "number"
    },
    "reminderFeesPolicy": {
      "description": "Rules and schedule for reminders with associated fees",
      "type": "object",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "title": "Reminder fees policy schema",
      "properties": {
        "countClosed": {
          "description": "A flag to determine if a reminder fee should take closed days into account",
          "type": "boolean"
        },
        "ignoreGracePeriodRecall": {
          "description": "Ignore grace period for recall",
          "type": "boolean"
        },
        "ignoreGracePeriodHolds": {
          "description": "Ignore grace period for holds",
          "type": "boolean"
        },
        "allowRenewalOfItemsWithReminderFees": {
          "description": "Allow renewal of items with reminder fee(s)",
          "type": "boolean"
        },
        "clearPatronBlockWhenPaid": {
          "description": "Clear patron block when paid",
          "type": "boolean"
        },
        "reminderSchedule": {
          "description": "Ordered list of reminder notices",
          "type": "array",
          "items": {
            "description": "Scheduled reminder notice with associated fee",
            "type": "object",
            "properties": {
              "interval": {
                "description": "Number of units of time before notice should be sent",
                "type": "integer"
              },
              "timeUnitId": {
                "description": "Time unit of interval",
                "type": "string",
                "enum": [
                  "day",
                  "week",
                  "minute"
                ]
              },
              "reminderFee": {
                "description": "Fee amount accrued by reminder notice",
                "javaType": "org.folio.rest.domain.MonetaryValue",
                "type": "number"
              },
              "noticeFormat": {
                "description": "Method of sending notice",
                "type": "string",
                "enum": [
                  "Email",
                  "Print",
                  "None"
                ]
              },
              "noticeTemplateId": {
                "description": "Id of reminder notice template",
                "$schema": "http://json-schema.org/draft-04/schema#",
                "id": "uuid.schema",
                "type": "string",
                "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
              },
              "blockTemplateId": {
                "description": "Id of block reminder template",
                "$schema": "http://json-schema.org/draft-04/schema#",
                "id": "uuid.schema",
                "type": "string",
                "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
              }
            },
            "additionalProperties": false,
            "required": [
              "interval",
              "timeUnitId",
              "reminderFee",
              "noticeMethodId",
              "noticeTemplateId"
            ]
          }
        }
      },
      "additionalProperties": false
    },
    "metadata": {
      "description": "Metadata about creation to overdue fine policy, provided by the server",
      "type": "object",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "id": "metadata.schema",
      "title": "Metadata Schema",
      "properties": {
        "createdDate": {
          "description": "Date and time when the record was created",
          "type": "string",
          "format": "date-time"
        },
        "createdByUserId": {
          "description": "ID of the user who created the record (when available)",
          "type": "string",
          "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
        },
        "createdByUsername": {
          "description": "Username of the user who created the record (when available)",
          "type": "string"
        },
        "updatedDate": {
          "description": "Date and time when the record was last updated",
          "type": "string",
          "format": "date-time"
        },
        "updatedByUserId": {
          "description": "ID of the user who last updated the record (when available)",
          "type": "string",
          "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
        },
        "updatedByUsername": {
          "description": "Username of the user who last updated the record (when available)",
          "type": "string"
        }
      },
      "additionalProperties": false,
      "required": [
        "createdDate"
      ]
    },
    "id": {
      "description": "Overdue fine policy id, UUID",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "id": "uuid.schema",
      "type": "string",
      "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
    }
  },
  "additionalProperties": false,
  "required": [
    "name"
  ]
}

Example:

{
  "name": "Faculty standard",
  "description": "This is description for Faculty standard",
  "overdueFine": {
    "quantity": 5.0,
    "intervalId": "day"
  },
  "countClosed": true,
  "maxOverdueFine": 50.00,
  "forgiveOverdueFine": true,
  "overdueRecallFine": {
    "quantity": 1.0,
    "intervalId": "hour"
  },
  "gracePeriodRecall": false,
  "maxOverdueRecallFine": 50.00,
  "id": "b712dffc-c107-4e88-b3d5-fba2fb35755e"
}

Response 201

Overdue fine policy created

Headers

Location: required (string)
URI to the created overdue-fines-policy item

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Overdue fine policies schema",
  "description": "Overdue fine policy to be associated with a loan policy by the Circulation Rules Editor",
  "type": "object",
  "properties": {
    "name": {
      "description": "Overdue fine policy name",
      "type": "string"
    },
    "description": {
      "description": "Overdue fine policy description",
      "type": "string"
    },
    "overdueFine": {
      "description": "Fine for overdue",
      "type": "object",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "properties": {
        "quantity": {
          "description": "Fine amount per interval",
          "javaType": "org.folio.rest.domain.MonetaryValue",
          "type": "number"
        },
        "intervalId": {
          "description": "Interval for the period, e.g. hour, day, week, month or year",
          "type": "string",
          "enum": [
            "minute",
            "hour",
            "day",
            "week",
            "month",
            "year"
          ]
        }
      },
      "additionalProperties": false
    },
    "countClosed": {
      "description": "A flag to determine if a fine is count closed",
      "type": "boolean"
    },
    "maxOverdueFine": {
      "description": "Maximum overdue fine",
      "javaType": "org.folio.rest.domain.MonetaryValue",
      "type": "number"
    },
    "forgiveOverdueFine": {
      "description": "A flag to determine forgive overdue fine if item renewed",
      "type": "boolean"
    },
    "overdueRecallFine": {
      "description": "Fine overdue recall fine",
      "type": "object",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "properties": {
        "quantity": {
          "description": "Fine amount per interval",
          "javaType": "org.folio.rest.domain.MonetaryValue",
          "type": "number"
        },
        "intervalId": {
          "description": "Interval for the period, e.g. hour, day, week, month or year",
          "type": "string",
          "enum": [
            "minute",
            "hour",
            "day",
            "week",
            "month",
            "year"
          ]
        }
      },
      "additionalProperties": false
    },
    "gracePeriodRecall": {
      "description": "Grace period for recall",
      "type": "boolean"
    },
    "maxOverdueRecallFine": {
      "description": "Maximum overdue recall fine",
      "javaType": "org.folio.rest.domain.MonetaryValue",
      "type": "number"
    },
    "reminderFeesPolicy": {
      "description": "Rules and schedule for reminders with associated fees",
      "type": "object",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "title": "Reminder fees policy schema",
      "properties": {
        "countClosed": {
          "description": "A flag to determine if a reminder fee should take closed days into account",
          "type": "boolean"
        },
        "ignoreGracePeriodRecall": {
          "description": "Ignore grace period for recall",
          "type": "boolean"
        },
        "ignoreGracePeriodHolds": {
          "description": "Ignore grace period for holds",
          "type": "boolean"
        },
        "allowRenewalOfItemsWithReminderFees": {
          "description": "Allow renewal of items with reminder fee(s)",
          "type": "boolean"
        },
        "clearPatronBlockWhenPaid": {
          "description": "Clear patron block when paid",
          "type": "boolean"
        },
        "reminderSchedule": {
          "description": "Ordered list of reminder notices",
          "type": "array",
          "items": {
            "description": "Scheduled reminder notice with associated fee",
            "type": "object",
            "properties": {
              "interval": {
                "description": "Number of units of time before notice should be sent",
                "type": "integer"
              },
              "timeUnitId": {
                "description": "Time unit of interval",
                "type": "string",
                "enum": [
                  "day",
                  "week",
                  "minute"
                ]
              },
              "reminderFee": {
                "description": "Fee amount accrued by reminder notice",
                "javaType": "org.folio.rest.domain.MonetaryValue",
                "type": "number"
              },
              "noticeFormat": {
                "description": "Method of sending notice",
                "type": "string",
                "enum": [
                  "Email",
                  "Print",
                  "None"
                ]
              },
              "noticeTemplateId": {
                "description": "Id of reminder notice template",
                "$schema": "http://json-schema.org/draft-04/schema#",
                "id": "uuid.schema",
                "type": "string",
                "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
              },
              "blockTemplateId": {
                "description": "Id of block reminder template",
                "$schema": "http://json-schema.org/draft-04/schema#",
                "id": "uuid.schema",
                "type": "string",
                "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
              }
            },
            "additionalProperties": false,
            "required": [
              "interval",
              "timeUnitId",
              "reminderFee",
              "noticeMethodId",
              "noticeTemplateId"
            ]
          }
        }
      },
      "additionalProperties": false
    },
    "metadata": {
      "description": "Metadata about creation to overdue fine policy, provided by the server",
      "type": "object",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "id": "metadata.schema",
      "title": "Metadata Schema",
      "properties": {
        "createdDate": {
          "description": "Date and time when the record was created",
          "type": "string",
          "format": "date-time"
        },
        "createdByUserId": {
          "description": "ID of the user who created the record (when available)",
          "type": "string",
          "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
        },
        "createdByUsername": {
          "description": "Username of the user who created the record (when available)",
          "type": "string"
        },
        "updatedDate": {
          "description": "Date and time when the record was last updated",
          "type": "string",
          "format": "date-time"
        },
        "updatedByUserId": {
          "description": "ID of the user who last updated the record (when available)",
          "type": "string",
          "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
        },
        "updatedByUsername": {
          "description": "Username of the user who last updated the record (when available)",
          "type": "string"
        }
      },
      "additionalProperties": false,
      "required": [
        "createdDate"
      ]
    },
    "id": {
      "description": "Overdue fine policy id, UUID",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "id": "uuid.schema",
      "type": "string",
      "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
    }
  },
  "additionalProperties": false,
  "required": [
    "name"
  ]
}

Example:

{
  "name": "Faculty standard",
  "description": "This is description for Faculty standard",
  "overdueFine": {
    "quantity": 5.0,
    "intervalId": "day"
  },
  "countClosed": true,
  "maxOverdueFine": 50.00,
  "forgiveOverdueFine": true,
  "overdueRecallFine": {
    "quantity": 1.0,
    "intervalId": "hour"
  },
  "gracePeriodRecall": false,
  "maxOverdueRecallFine": 50.00,
  "id": "b712dffc-c107-4e88-b3d5-fba2fb35755e"
}

Response 400

Bad request, e.g. malformed request body or query parameter. Details of the error (e.g. name of the parameter or line/character number with malformed data) provided in the response.

Body

Media type: text/plain

Type: any

Example:

"unable to add overdue-fines-policy -- malformed JSON at 13:3"

Response 401

Not authorized to perform requested action

Body

Media type: text/plain

Type: any

Example:

unable to create overdue-fines-policies -- unauthorized

Response 422

Unprocessable entity

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "id": "errors.schema",
  "description": "A set of errors",
  "type": "object",
  "properties": {
    "errors": {
      "description": "List of errors",
      "id": "errors",
      "type": "array",
      "items": {
        "type": "object",
        "$schema": "http://json-schema.org/draft-04/schema#",
        "id": "error.schema",
        "description": "An error",
        "properties": {
          "message": {
            "type": "string",
            "description": "Error message text"
          },
          "type": {
            "type": "string",
            "description": "Error message type"
          },
          "code": {
            "type": "string",
            "description": "Error message code"
          },
          "parameters": {
            "description": "Error message parameters",
            "$schema": "http://json-schema.org/draft-04/schema#",
            "id": "parameters.schema",
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "key": {
                  "type": "string"
                },
                "value": {
                  "type": "string"
                }
              }
            }
          }
        },
        "required": [
          "message"
        ]
      }
    },
    "total_records": {
      "description": "Total number of errors",
      "type": "integer"
    }
  }
}

Example:

{
  "errors": [
    {
      "message": "may not be null",
      "type": "1",
      "code": "-1",
      "parameters": [
        {
          "key": "moduleTo",
          "value": "null"
        }
      ]
    }
  ]
}

Response 500

Internal server error

Body

Media type: text/plain

Type: any

Example:

Internal server error

GET /overdue-fines-policies/{overdueFinePolicyId}

Get Overdue Fine Policy by id

GET /overdue-fines-policies/{overdueFinePolicyId}

URI Parameters

overdueFinePolicyId: required (string)

Response 200

Return Overdue Fine Policy

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Overdue fine policies schema",
  "description": "Overdue fine policy to be associated with a loan policy by the Circulation Rules Editor",
  "type": "object",
  "properties": {
    "name": {
      "description": "Overdue fine policy name",
      "type": "string"
    },
    "description": {
      "description": "Overdue fine policy description",
      "type": "string"
    },
    "overdueFine": {
      "description": "Fine for overdue",
      "type": "object",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "properties": {
        "quantity": {
          "description": "Fine amount per interval",
          "javaType": "org.folio.rest.domain.MonetaryValue",
          "type": "number"
        },
        "intervalId": {
          "description": "Interval for the period, e.g. hour, day, week, month or year",
          "type": "string",
          "enum": [
            "minute",
            "hour",
            "day",
            "week",
            "month",
            "year"
          ]
        }
      },
      "additionalProperties": false
    },
    "countClosed": {
      "description": "A flag to determine if a fine is count closed",
      "type": "boolean"
    },
    "maxOverdueFine": {
      "description": "Maximum overdue fine",
      "javaType": "org.folio.rest.domain.MonetaryValue",
      "type": "number"
    },
    "forgiveOverdueFine": {
      "description": "A flag to determine forgive overdue fine if item renewed",
      "type": "boolean"
    },
    "overdueRecallFine": {
      "description": "Fine overdue recall fine",
      "type": "object",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "properties": {
        "quantity": {
          "description": "Fine amount per interval",
          "javaType": "org.folio.rest.domain.MonetaryValue",
          "type": "number"
        },
        "intervalId": {
          "description": "Interval for the period, e.g. hour, day, week, month or year",
          "type": "string",
          "enum": [
            "minute",
            "hour",
            "day",
            "week",
            "month",
            "year"
          ]
        }
      },
      "additionalProperties": false
    },
    "gracePeriodRecall": {
      "description": "Grace period for recall",
      "type": "boolean"
    },
    "maxOverdueRecallFine": {
      "description": "Maximum overdue recall fine",
      "javaType": "org.folio.rest.domain.MonetaryValue",
      "type": "number"
    },
    "reminderFeesPolicy": {
      "description": "Rules and schedule for reminders with associated fees",
      "type": "object",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "title": "Reminder fees policy schema",
      "properties": {
        "countClosed": {
          "description": "A flag to determine if a reminder fee should take closed days into account",
          "type": "boolean"
        },
        "ignoreGracePeriodRecall": {
          "description": "Ignore grace period for recall",
          "type": "boolean"
        },
        "ignoreGracePeriodHolds": {
          "description": "Ignore grace period for holds",
          "type": "boolean"
        },
        "allowRenewalOfItemsWithReminderFees": {
          "description": "Allow renewal of items with reminder fee(s)",
          "type": "boolean"
        },
        "clearPatronBlockWhenPaid": {
          "description": "Clear patron block when paid",
          "type": "boolean"
        },
        "reminderSchedule": {
          "description": "Ordered list of reminder notices",
          "type": "array",
          "items": {
            "description": "Scheduled reminder notice with associated fee",
            "type": "object",
            "properties": {
              "interval": {
                "description": "Number of units of time before notice should be sent",
                "type": "integer"
              },
              "timeUnitId": {
                "description": "Time unit of interval",
                "type": "string",
                "enum": [
                  "day",
                  "week",
                  "minute"
                ]
              },
              "reminderFee": {
                "description": "Fee amount accrued by reminder notice",
                "javaType": "org.folio.rest.domain.MonetaryValue",
                "type": "number"
              },
              "noticeFormat": {
                "description": "Method of sending notice",
                "type": "string",
                "enum": [
                  "Email",
                  "Print",
                  "None"
                ]
              },
              "noticeTemplateId": {
                "description": "Id of reminder notice template",
                "$schema": "http://json-schema.org/draft-04/schema#",
                "id": "uuid.schema",
                "type": "string",
                "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
              },
              "blockTemplateId": {
                "description": "Id of block reminder template",
                "$schema": "http://json-schema.org/draft-04/schema#",
                "id": "uuid.schema",
                "type": "string",
                "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
              }
            },
            "additionalProperties": false,
            "required": [
              "interval",
              "timeUnitId",
              "reminderFee",
              "noticeMethodId",
              "noticeTemplateId"
            ]
          }
        }
      },
      "additionalProperties": false
    },
    "metadata": {
      "description": "Metadata about creation to overdue fine policy, provided by the server",
      "type": "object",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "id": "metadata.schema",
      "title": "Metadata Schema",
      "properties": {
        "createdDate": {
          "description": "Date and time when the record was created",
          "type": "string",
          "format": "date-time"
        },
        "createdByUserId": {
          "description": "ID of the user who created the record (when available)",
          "type": "string",
          "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
        },
        "createdByUsername": {
          "description": "Username of the user who created the record (when available)",
          "type": "string"
        },
        "updatedDate": {
          "description": "Date and time when the record was last updated",
          "type": "string",
          "format": "date-time"
        },
        "updatedByUserId": {
          "description": "ID of the user who last updated the record (when available)",
          "type": "string",
          "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
        },
        "updatedByUsername": {
          "description": "Username of the user who last updated the record (when available)",
          "type": "string"
        }
      },
      "additionalProperties": false,
      "required": [
        "createdDate"
      ]
    },
    "id": {
      "description": "Overdue fine policy id, UUID",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "id": "uuid.schema",
      "type": "string",
      "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
    }
  },
  "additionalProperties": false,
  "required": [
    "name"
  ]
}

Example:

{
  "name": "Faculty standard",
  "description": "This is description for Faculty standard",
  "overdueFine": {
    "quantity": 5.0,
    "intervalId": "day"
  },
  "countClosed": true,
  "maxOverdueFine": 50.00,
  "forgiveOverdueFine": true,
  "overdueRecallFine": {
    "quantity": 1.0,
    "intervalId": "hour"
  },
  "gracePeriodRecall": false,
  "maxOverdueRecallFine": 50.00,
  "id": "b712dffc-c107-4e88-b3d5-fba2fb35755e"
}

Response 404

Not found

Body

Media type: text/plain

Type: any

Example:

Not found

Response 500

Internal server error

Body

Media type: text/plain

Type: any

Example:

Internal server error

DELETE /overdue-fines-policies/{overdueFinePolicyId}

Delete Overdue Fine Policy by id

DELETE /overdue-fines-policies/{overdueFinePolicyId}

URI Parameters

overdueFinePolicyId: required (string)

Response 204

Source record deleted

Response 400

Bad request, e.g. malformed request body, query parameter or constraint violation.

Body

Media type: text/plain

Type: any

Example:

Cannot delete in use fine policy

Response 404

There is no source record for that overdueFinePolicyId

Body

Media type: text/plain

Type: any

Example:

Not found

Response 500

Internal server error

Body

Media type: text/plain

Type: any

Example:

Internal server error

PUT /overdue-fines-policies/{overdueFinePolicyId}

Update overdue-fines-policy item with given {overdue-fines-policyId}

PUT /overdue-fines-policies/{overdueFinePolicyId}

URI Parameters

overdueFinePolicyId: required (string)

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Overdue fine policies schema",
  "description": "Overdue fine policy to be associated with a loan policy by the Circulation Rules Editor",
  "type": "object",
  "properties": {
    "name": {
      "description": "Overdue fine policy name",
      "type": "string"
    },
    "description": {
      "description": "Overdue fine policy description",
      "type": "string"
    },
    "overdueFine": {
      "description": "Fine for overdue",
      "type": "object",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "properties": {
        "quantity": {
          "description": "Fine amount per interval",
          "javaType": "org.folio.rest.domain.MonetaryValue",
          "type": "number"
        },
        "intervalId": {
          "description": "Interval for the period, e.g. hour, day, week, month or year",
          "type": "string",
          "enum": [
            "minute",
            "hour",
            "day",
            "week",
            "month",
            "year"
          ]
        }
      },
      "additionalProperties": false
    },
    "countClosed": {
      "description": "A flag to determine if a fine is count closed",
      "type": "boolean"
    },
    "maxOverdueFine": {
      "description": "Maximum overdue fine",
      "javaType": "org.folio.rest.domain.MonetaryValue",
      "type": "number"
    },
    "forgiveOverdueFine": {
      "description": "A flag to determine forgive overdue fine if item renewed",
      "type": "boolean"
    },
    "overdueRecallFine": {
      "description": "Fine overdue recall fine",
      "type": "object",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "properties": {
        "quantity": {
          "description": "Fine amount per interval",
          "javaType": "org.folio.rest.domain.MonetaryValue",
          "type": "number"
        },
        "intervalId": {
          "description": "Interval for the period, e.g. hour, day, week, month or year",
          "type": "string",
          "enum": [
            "minute",
            "hour",
            "day",
            "week",
            "month",
            "year"
          ]
        }
      },
      "additionalProperties": false
    },
    "gracePeriodRecall": {
      "description": "Grace period for recall",
      "type": "boolean"
    },
    "maxOverdueRecallFine": {
      "description": "Maximum overdue recall fine",
      "javaType": "org.folio.rest.domain.MonetaryValue",
      "type": "number"
    },
    "reminderFeesPolicy": {
      "description": "Rules and schedule for reminders with associated fees",
      "type": "object",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "title": "Reminder fees policy schema",
      "properties": {
        "countClosed": {
          "description": "A flag to determine if a reminder fee should take closed days into account",
          "type": "boolean"
        },
        "ignoreGracePeriodRecall": {
          "description": "Ignore grace period for recall",
          "type": "boolean"
        },
        "ignoreGracePeriodHolds": {
          "description": "Ignore grace period for holds",
          "type": "boolean"
        },
        "allowRenewalOfItemsWithReminderFees": {
          "description": "Allow renewal of items with reminder fee(s)",
          "type": "boolean"
        },
        "clearPatronBlockWhenPaid": {
          "description": "Clear patron block when paid",
          "type": "boolean"
        },
        "reminderSchedule": {
          "description": "Ordered list of reminder notices",
          "type": "array",
          "items": {
            "description": "Scheduled reminder notice with associated fee",
            "type": "object",
            "properties": {
              "interval": {
                "description": "Number of units of time before notice should be sent",
                "type": "integer"
              },
              "timeUnitId": {
                "description": "Time unit of interval",
                "type": "string",
                "enum": [
                  "day",
                  "week",
                  "minute"
                ]
              },
              "reminderFee": {
                "description": "Fee amount accrued by reminder notice",
                "javaType": "org.folio.rest.domain.MonetaryValue",
                "type": "number"
              },
              "noticeFormat": {
                "description": "Method of sending notice",
                "type": "string",
                "enum": [
                  "Email",
                  "Print",
                  "None"
                ]
              },
              "noticeTemplateId": {
                "description": "Id of reminder notice template",
                "$schema": "http://json-schema.org/draft-04/schema#",
                "id": "uuid.schema",
                "type": "string",
                "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
              },
              "blockTemplateId": {
                "description": "Id of block reminder template",
                "$schema": "http://json-schema.org/draft-04/schema#",
                "id": "uuid.schema",
                "type": "string",
                "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
              }
            },
            "additionalProperties": false,
            "required": [
              "interval",
              "timeUnitId",
              "reminderFee",
              "noticeMethodId",
              "noticeTemplateId"
            ]
          }
        }
      },
      "additionalProperties": false
    },
    "metadata": {
      "description": "Metadata about creation to overdue fine policy, provided by the server",
      "type": "object",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "id": "metadata.schema",
      "title": "Metadata Schema",
      "properties": {
        "createdDate": {
          "description": "Date and time when the record was created",
          "type": "string",
          "format": "date-time"
        },
        "createdByUserId": {
          "description": "ID of the user who created the record (when available)",
          "type": "string",
          "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
        },
        "createdByUsername": {
          "description": "Username of the user who created the record (when available)",
          "type": "string"
        },
        "updatedDate": {
          "description": "Date and time when the record was last updated",
          "type": "string",
          "format": "date-time"
        },
        "updatedByUserId": {
          "description": "ID of the user who last updated the record (when available)",
          "type": "string",
          "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
        },
        "updatedByUsername": {
          "description": "Username of the user who last updated the record (when available)",
          "type": "string"
        }
      },
      "additionalProperties": false,
      "required": [
        "createdDate"
      ]
    },
    "id": {
      "description": "Overdue fine policy id, UUID",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "id": "uuid.schema",
      "type": "string",
      "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
    }
  },
  "additionalProperties": false,
  "required": [
    "name"
  ]
}

Example:

{
  "name": "Faculty standard",
  "description": "This is description for Faculty standard",
  "overdueFine": {
    "quantity": 5.0,
    "intervalId": "day"
  },
  "countClosed": true,
  "maxOverdueFine": 50.00,
  "forgiveOverdueFine": true,
  "overdueRecallFine": {
    "quantity": 1.0,
    "intervalId": "hour"
  },
  "gracePeriodRecall": false,
  "maxOverdueRecallFine": 50.00,
  "id": "b712dffc-c107-4e88-b3d5-fba2fb35755e"
}

Response 204

Item successfully updated

Response 400

Bad request, e.g. malformed request body or query parameter. Details of the error (e.g. name of the parameter or line/character number with malformed data) provided in the response.

Body

Media type: text/plain

Type: any

Example:

"unable to update overdue-fines-policy -- malformed JSON at 13:4"

Response 404

Item with a given ID not found

Body

Media type: text/plain

Type: any

Example:

"overdue-fines-policy not found"

Response 409

Optimistic locking version conflict

Body

Media type: text/plain

Type: any

Example:

version conflict

Response 500

Internal server error, e.g. due to misconfiguration

Body

Media type: text/plain

Type: any

Example:

internal server error, contact administrator

Overdue Fine Policies (v1.1)

Table of contents

Overdue Fine Policies API

/overdue-fines-policies

GET /overdue-fines-policies

Query Parameters

Response 200

Response 400

Response 401

Response 500

POST /overdue-fines-policies

Response 201

Headers

Response 400

Response 401

Response 422

Response 500

GET /overdue-fines-policies/{overdueFinePolicyId}

URI Parameters

Response 200

Response 404

Response 500

DELETE /overdue-fines-policies/{overdueFinePolicyId}

URI Parameters

Response 204

Response 400

Response 404

Response 500

PUT /overdue-fines-policies/{overdueFinePolicyId}

URI Parameters

Response 204

Response 400

Response 404

Response 409

Response 500