Lost Item Fee Policies (v16.3)

http://localhost:9130

Lost Item Fee Policies API
/lost-item-fees-policies

Lost Item Fee Policies API

Lost Item Fee Policies

/lost-item-fees-policies

Collection of lost-item-fees-policy items.

GET /lost-item-fees-policies

Get Lost Item Fee Policy list

GET /lost-item-fees-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 Lost Item Fee Policy list

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "Collection of lost item fee policies",
  "type": "object",
  "properties": {
    "lostItemFeePolicies": {
      "description": "List of lost item fee policies",
      "id": "lostItemFeePolicies",
      "type": "array",
      "items": {
        "type": "object",
        "$schema": "http://json-schema.org/draft-04/schema#",
        "title": "CRUD lost item fee policy schema",
        "description": "CRUD to lost item fee policies",
        "properties": {
          "name": {
            "description": "Lost item fee policy name, is a required field",
            "type": "string"
          },
          "description": {
            "description": "Lost item fee policy description",
            "type": "string"
          },
          "itemAgedLostOverdue": {
            "description": "Items aged to lost after overdue entered, must be 0 or > 0 and, if > 0 must have interval selected",
            "type": "object",
            "$schema": "http://json-schema.org/draft-04/schema#",
            "properties": {
              "duration": {
                "description": "Duration of the number of times the interval repeats",
                "type": "integer",
                "minimum": 1
              },
              "intervalId": {
                "type": "string",
                "description": "Interval for the period, e.g. Hours, Days or Weeks",
                "enum": [
                  "Minutes",
                  "Hours",
                  "Days",
                  "Weeks",
                  "Months",
                  "Years"
                ]
              }
            },
            "additionalProperties": false
          },
          "patronBilledAfterAgedLost": {
            "description": "Patron billed after aged to lost entered, must be 0 or > 0 and, if > 0 must have interval selected",
            "type": "object",
            "$schema": "http://json-schema.org/draft-04/schema#",
            "properties": {
              "duration": {
                "description": "Duration of the number of times the interval repeats",
                "type": "integer",
                "minimum": 1
              },
              "intervalId": {
                "type": "string",
                "description": "Interval for the period, e.g. Hours, Days or Weeks",
                "enum": [
                  "Minutes",
                  "Hours",
                  "Days",
                  "Weeks",
                  "Months",
                  "Years"
                ]
              }
            },
            "additionalProperties": false
          },
          "recalledItemAgedLostOverdue": {
            "description": "Recalled items aged to lost after overdue entered, must be 0 or > 0 and, if > 0 must have interval selected",
            "type": "object",
            "$schema": "http://json-schema.org/draft-04/schema#",
            "properties": {
              "duration": {
                "description": "Duration of the number of times the interval repeats",
                "type": "integer",
                "minimum": 1
              },
              "intervalId": {
                "type": "string",
                "description": "Interval for the period, e.g. Hours, Days or Weeks",
                "enum": [
                  "Minutes",
                  "Hours",
                  "Days",
                  "Weeks",
                  "Months",
                  "Years"
                ]
              }
            },
            "additionalProperties": false
          },
          "patronBilledAfterRecalledItemAgedLost": {
            "description": "Patron billed after a recalled item aged to lost entered, must be 0 or > 0 and, if > 0 must have interval selected",
            "type": "object",
            "$schema": "http://json-schema.org/draft-04/schema#",
            "properties": {
              "duration": {
                "description": "Duration of the number of times the interval repeats",
                "type": "integer",
                "minimum": 1
              },
              "intervalId": {
                "type": "string",
                "description": "Interval for the period, e.g. Hours, Days or Weeks",
                "enum": [
                  "Minutes",
                  "Hours",
                  "Days",
                  "Weeks",
                  "Months",
                  "Years"
                ]
              }
            },
            "additionalProperties": false
          },
          "chargeAmountItem": {
            "description": "Option to charge amount for item",
            "type": "object",
            "$schema": "http://json-schema.org/draft-04/schema#",
            "properties": {
              "chargeType": {
                "description": "Charge type amount for item may be Actual cost or an amount",
                "type": "string"
              },
              "amount": {
                "description": "Charge amount for item may be Actual cost or an amount",
                "javaType": "org.folio.rest.domain.MonetaryValue",
                "type": "number"
              }
            },
            "additionalProperties": false
          },
          "lostItemProcessingFee": {
            "description": "Lost item processing fee, must be = 0 or > 0",
            "javaType": "org.folio.rest.domain.MonetaryValue",
            "type": "number"
          },
          "chargeAmountItemPatron": {
            "description": "A flag to determine charge lost item processing fee if item declared lost by patron must be Yes or No, with default set to Yes",
            "type": "boolean"
          },
          "chargeAmountItemSystem": {
            "description": "A flag to determine charge lost item processing fee if item aged to lost by system must be Yes or No, with default set to Yes",
            "type": "boolean"
          },
          "lostItemChargeFeeFine": {
            "description": "For items not charged a fee/fine, close the loan after entered, must be 0 or > 0 and, if > 0 must have interval selected",
            "type": "object",
            "$schema": "http://json-schema.org/draft-04/schema#",
            "properties": {
              "duration": {
                "description": "Duration of the number of times the interval repeats",
                "type": "integer",
                "minimum": 1
              },
              "intervalId": {
                "type": "string",
                "description": "Interval for the period, e.g. Hours, Days or Weeks",
                "enum": [
                  "Minutes",
                  "Hours",
                  "Days",
                  "Weeks",
                  "Months",
                  "Years"
                ]
              }
            },
            "additionalProperties": false
          },
          "returnedLostItemProcessingFee": {
            "description": "A flag to determine if lost item returned, remove lost item processing fee",
            "type": "boolean"
          },
          "replacedLostItemProcessingFee": {
            "description": "A flag to determine if lost item replaced, remove lost item processing fee",
            "type": "boolean"
          },
          "replacementProcessingFee": {
            "description": "Amount for replacement process fee",
            "javaType": "org.folio.rest.domain.MonetaryValue",
            "type": "number"
          },
          "replacementAllowed": {
            "description": "A flag to determine replacement allowed",
            "type": "boolean"
          },
          "lostItemReturned": {
            "description": "Option to lost item returned may be Charge overdues based on returned date up to maximum (if applicable) or Remove overdue fines, with a default of _Charge overdues based on returned date up to maximum (if applicable)",
            "type": "string"
          },
          "feesFinesShallRefunded": {
            "description": "Fees/fines shall be refunded if a lost item is returned more than entered, must be 0 or > 0 and, if > 0 must have interval selected",
            "type": "object",
            "$schema": "http://json-schema.org/draft-04/schema#",
            "properties": {
              "duration": {
                "description": "Duration of the number of times the interval repeats",
                "type": "integer",
                "minimum": 1
              },
              "intervalId": {
                "type": "string",
                "description": "Interval for the period, e.g. Hours, Days or Weeks",
                "enum": [
                  "Minutes",
                  "Hours",
                  "Days",
                  "Weeks",
                  "Months",
                  "Years"
                ]
              }
            },
            "additionalProperties": false
          },
          "metadata": {
            "description": "Metadata about creation to lost item fee 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": "Lost item fee 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": [
    "lostItemFeePolicies",
    "totalRecords"
  ]
}

Example:

{
  "overdueFinePolicies": [
    {
      "name": "Undergrad standard",
      "description": "This is description for undergrad standard",
      "itemAgedLostOverdue": {
        "duration": 12,
        "intervalId": "Months"
      },
      "patronBilledAfterAgedLost": {
        "duration": 12,
        "intervalId": "Months"
      },
      "chargeAmountItem": {
        "chargeType": "Actual cost",
        "amount": 5.00
      },
      "lostItemProcessingFee": 5.00,
      "chargeAmountItemPatron": true,
      "chargeAmountItemSystem": true,
      "lostItemChargeFeeFine": {
        "duration": 6,
        "intervalId": "Months"
      },
      "returnedLostItemProcessingFee": true,
      "replacedLostItemProcessingFee": true,
      "replacementProcessingFee": 0.00,
      "replacementAllowed": true,
      "lostItemReturned": "Charge",
      "id": "0c340536-8ed7-409e-8940-e65f2330d4d7"
    }
  ],
  "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 lost-item-fees-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 lost-item-fees-policies -- unauthorized

Response 500

Internal server error

Body

Media type: text/plain

Type: any

Example:

Internal server error

POST /lost-item-fees-policies

Create new Lost Item Fee Policy

POST /lost-item-fees-policies

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "CRUD lost item fee policy schema",
  "description": "CRUD to lost item fee policies",
  "type": "object",
  "properties": {
    "name": {
      "description": "Lost item fee policy name, is a required field",
      "type": "string"
    },
    "description": {
      "description": "Lost item fee policy description",
      "type": "string"
    },
    "itemAgedLostOverdue": {
      "description": "Items aged to lost after overdue entered, must be 0 or > 0 and, if > 0 must have interval selected",
      "type": "object",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "properties": {
        "duration": {
          "description": "Duration of the number of times the interval repeats",
          "type": "integer",
          "minimum": 1
        },
        "intervalId": {
          "type": "string",
          "description": "Interval for the period, e.g. Hours, Days or Weeks",
          "enum": [
            "Minutes",
            "Hours",
            "Days",
            "Weeks",
            "Months",
            "Years"
          ]
        }
      },
      "additionalProperties": false
    },
    "patronBilledAfterAgedLost": {
      "description": "Patron billed after aged to lost entered, must be 0 or > 0 and, if > 0 must have interval selected",
      "type": "object",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "properties": {
        "duration": {
          "description": "Duration of the number of times the interval repeats",
          "type": "integer",
          "minimum": 1
        },
        "intervalId": {
          "type": "string",
          "description": "Interval for the period, e.g. Hours, Days or Weeks",
          "enum": [
            "Minutes",
            "Hours",
            "Days",
            "Weeks",
            "Months",
            "Years"
          ]
        }
      },
      "additionalProperties": false
    },
    "recalledItemAgedLostOverdue": {
      "description": "Recalled items aged to lost after overdue entered, must be 0 or > 0 and, if > 0 must have interval selected",
      "type": "object",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "properties": {
        "duration": {
          "description": "Duration of the number of times the interval repeats",
          "type": "integer",
          "minimum": 1
        },
        "intervalId": {
          "type": "string",
          "description": "Interval for the period, e.g. Hours, Days or Weeks",
          "enum": [
            "Minutes",
            "Hours",
            "Days",
            "Weeks",
            "Months",
            "Years"
          ]
        }
      },
      "additionalProperties": false
    },
    "patronBilledAfterRecalledItemAgedLost": {
      "description": "Patron billed after a recalled item aged to lost entered, must be 0 or > 0 and, if > 0 must have interval selected",
      "type": "object",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "properties": {
        "duration": {
          "description": "Duration of the number of times the interval repeats",
          "type": "integer",
          "minimum": 1
        },
        "intervalId": {
          "type": "string",
          "description": "Interval for the period, e.g. Hours, Days or Weeks",
          "enum": [
            "Minutes",
            "Hours",
            "Days",
            "Weeks",
            "Months",
            "Years"
          ]
        }
      },
      "additionalProperties": false
    },
    "chargeAmountItem": {
      "description": "Option to charge amount for item",
      "type": "object",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "properties": {
        "chargeType": {
          "description": "Charge type amount for item may be Actual cost or an amount",
          "type": "string"
        },
        "amount": {
          "description": "Charge amount for item may be Actual cost or an amount",
          "javaType": "org.folio.rest.domain.MonetaryValue",
          "type": "number"
        }
      },
      "additionalProperties": false
    },
    "lostItemProcessingFee": {
      "description": "Lost item processing fee, must be = 0 or > 0",
      "javaType": "org.folio.rest.domain.MonetaryValue",
      "type": "number"
    },
    "chargeAmountItemPatron": {
      "description": "A flag to determine charge lost item processing fee if item declared lost by patron must be Yes or No, with default set to Yes",
      "type": "boolean"
    },
    "chargeAmountItemSystem": {
      "description": "A flag to determine charge lost item processing fee if item aged to lost by system must be Yes or No, with default set to Yes",
      "type": "boolean"
    },
    "lostItemChargeFeeFine": {
      "description": "For items not charged a fee/fine, close the loan after entered, must be 0 or > 0 and, if > 0 must have interval selected",
      "type": "object",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "properties": {
        "duration": {
          "description": "Duration of the number of times the interval repeats",
          "type": "integer",
          "minimum": 1
        },
        "intervalId": {
          "type": "string",
          "description": "Interval for the period, e.g. Hours, Days or Weeks",
          "enum": [
            "Minutes",
            "Hours",
            "Days",
            "Weeks",
            "Months",
            "Years"
          ]
        }
      },
      "additionalProperties": false
    },
    "returnedLostItemProcessingFee": {
      "description": "A flag to determine if lost item returned, remove lost item processing fee",
      "type": "boolean"
    },
    "replacedLostItemProcessingFee": {
      "description": "A flag to determine if lost item replaced, remove lost item processing fee",
      "type": "boolean"
    },
    "replacementProcessingFee": {
      "description": "Amount for replacement process fee",
      "javaType": "org.folio.rest.domain.MonetaryValue",
      "type": "number"
    },
    "replacementAllowed": {
      "description": "A flag to determine replacement allowed",
      "type": "boolean"
    },
    "lostItemReturned": {
      "description": "Option to lost item returned may be Charge overdues based on returned date up to maximum (if applicable) or Remove overdue fines, with a default of _Charge overdues based on returned date up to maximum (if applicable)",
      "type": "string"
    },
    "feesFinesShallRefunded": {
      "description": "Fees/fines shall be refunded if a lost item is returned more than entered, must be 0 or > 0 and, if > 0 must have interval selected",
      "type": "object",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "properties": {
        "duration": {
          "description": "Duration of the number of times the interval repeats",
          "type": "integer",
          "minimum": 1
        },
        "intervalId": {
          "type": "string",
          "description": "Interval for the period, e.g. Hours, Days or Weeks",
          "enum": [
            "Minutes",
            "Hours",
            "Days",
            "Weeks",
            "Months",
            "Years"
          ]
        }
      },
      "additionalProperties": false
    },
    "metadata": {
      "description": "Metadata about creation to lost item fee 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": "Lost item fee 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": "Undergrad standard",
  "description": "This is description for undergrad standard",
  "itemAgedLostOverdue": {
    "duration": 12,
    "intervalId": "Months"
  },
  "patronBilledAfterAgedLost": {
    "duration": 12,
    "intervalId": "Months"
  },
  "chargeAmountItem": {
    "chargeType": "Actual cost",
    "amount": 5.00
  },
  "lostItemProcessingFee": 5.00,
  "chargeAmountItemPatron": true,
  "chargeAmountItemSystem": true,
  "lostItemChargeFeeFine": {
    "duration": 6,
    "intervalId": "Months"
  },
  "returnedLostItemProcessingFee": true,
  "replacedLostItemProcessingFee": true,
  "replacementProcessingFee": 0.00,
  "replacementAllowed": true,
  "lostItemReturned": "Charge",
  "id": "0c340536-8ed7-409e-8940-e65f2330d4d7"
}

Response 201

Lost Item Fee policy created

Headers

Location: required (string)
URI to the created lost-item-fees-policy item

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "CRUD lost item fee policy schema",
  "description": "CRUD to lost item fee policies",
  "type": "object",
  "properties": {
    "name": {
      "description": "Lost item fee policy name, is a required field",
      "type": "string"
    },
    "description": {
      "description": "Lost item fee policy description",
      "type": "string"
    },
    "itemAgedLostOverdue": {
      "description": "Items aged to lost after overdue entered, must be 0 or > 0 and, if > 0 must have interval selected",
      "type": "object",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "properties": {
        "duration": {
          "description": "Duration of the number of times the interval repeats",
          "type": "integer",
          "minimum": 1
        },
        "intervalId": {
          "type": "string",
          "description": "Interval for the period, e.g. Hours, Days or Weeks",
          "enum": [
            "Minutes",
            "Hours",
            "Days",
            "Weeks",
            "Months",
            "Years"
          ]
        }
      },
      "additionalProperties": false
    },
    "patronBilledAfterAgedLost": {
      "description": "Patron billed after aged to lost entered, must be 0 or > 0 and, if > 0 must have interval selected",
      "type": "object",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "properties": {
        "duration": {
          "description": "Duration of the number of times the interval repeats",
          "type": "integer",
          "minimum": 1
        },
        "intervalId": {
          "type": "string",
          "description": "Interval for the period, e.g. Hours, Days or Weeks",
          "enum": [
            "Minutes",
            "Hours",
            "Days",
            "Weeks",
            "Months",
            "Years"
          ]
        }
      },
      "additionalProperties": false
    },
    "recalledItemAgedLostOverdue": {
      "description": "Recalled items aged to lost after overdue entered, must be 0 or > 0 and, if > 0 must have interval selected",
      "type": "object",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "properties": {
        "duration": {
          "description": "Duration of the number of times the interval repeats",
          "type": "integer",
          "minimum": 1
        },
        "intervalId": {
          "type": "string",
          "description": "Interval for the period, e.g. Hours, Days or Weeks",
          "enum": [
            "Minutes",
            "Hours",
            "Days",
            "Weeks",
            "Months",
            "Years"
          ]
        }
      },
      "additionalProperties": false
    },
    "patronBilledAfterRecalledItemAgedLost": {
      "description": "Patron billed after a recalled item aged to lost entered, must be 0 or > 0 and, if > 0 must have interval selected",
      "type": "object",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "properties": {
        "duration": {
          "description": "Duration of the number of times the interval repeats",
          "type": "integer",
          "minimum": 1
        },
        "intervalId": {
          "type": "string",
          "description": "Interval for the period, e.g. Hours, Days or Weeks",
          "enum": [
            "Minutes",
            "Hours",
            "Days",
            "Weeks",
            "Months",
            "Years"
          ]
        }
      },
      "additionalProperties": false
    },
    "chargeAmountItem": {
      "description": "Option to charge amount for item",
      "type": "object",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "properties": {
        "chargeType": {
          "description": "Charge type amount for item may be Actual cost or an amount",
          "type": "string"
        },
        "amount": {
          "description": "Charge amount for item may be Actual cost or an amount",
          "javaType": "org.folio.rest.domain.MonetaryValue",
          "type": "number"
        }
      },
      "additionalProperties": false
    },
    "lostItemProcessingFee": {
      "description": "Lost item processing fee, must be = 0 or > 0",
      "javaType": "org.folio.rest.domain.MonetaryValue",
      "type": "number"
    },
    "chargeAmountItemPatron": {
      "description": "A flag to determine charge lost item processing fee if item declared lost by patron must be Yes or No, with default set to Yes",
      "type": "boolean"
    },
    "chargeAmountItemSystem": {
      "description": "A flag to determine charge lost item processing fee if item aged to lost by system must be Yes or No, with default set to Yes",
      "type": "boolean"
    },
    "lostItemChargeFeeFine": {
      "description": "For items not charged a fee/fine, close the loan after entered, must be 0 or > 0 and, if > 0 must have interval selected",
      "type": "object",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "properties": {
        "duration": {
          "description": "Duration of the number of times the interval repeats",
          "type": "integer",
          "minimum": 1
        },
        "intervalId": {
          "type": "string",
          "description": "Interval for the period, e.g. Hours, Days or Weeks",
          "enum": [
            "Minutes",
            "Hours",
            "Days",
            "Weeks",
            "Months",
            "Years"
          ]
        }
      },
      "additionalProperties": false
    },
    "returnedLostItemProcessingFee": {
      "description": "A flag to determine if lost item returned, remove lost item processing fee",
      "type": "boolean"
    },
    "replacedLostItemProcessingFee": {
      "description": "A flag to determine if lost item replaced, remove lost item processing fee",
      "type": "boolean"
    },
    "replacementProcessingFee": {
      "description": "Amount for replacement process fee",
      "javaType": "org.folio.rest.domain.MonetaryValue",
      "type": "number"
    },
    "replacementAllowed": {
      "description": "A flag to determine replacement allowed",
      "type": "boolean"
    },
    "lostItemReturned": {
      "description": "Option to lost item returned may be Charge overdues based on returned date up to maximum (if applicable) or Remove overdue fines, with a default of _Charge overdues based on returned date up to maximum (if applicable)",
      "type": "string"
    },
    "feesFinesShallRefunded": {
      "description": "Fees/fines shall be refunded if a lost item is returned more than entered, must be 0 or > 0 and, if > 0 must have interval selected",
      "type": "object",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "properties": {
        "duration": {
          "description": "Duration of the number of times the interval repeats",
          "type": "integer",
          "minimum": 1
        },
        "intervalId": {
          "type": "string",
          "description": "Interval for the period, e.g. Hours, Days or Weeks",
          "enum": [
            "Minutes",
            "Hours",
            "Days",
            "Weeks",
            "Months",
            "Years"
          ]
        }
      },
      "additionalProperties": false
    },
    "metadata": {
      "description": "Metadata about creation to lost item fee 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": "Lost item fee 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": "Undergrad standard",
  "description": "This is description for undergrad standard",
  "itemAgedLostOverdue": {
    "duration": 12,
    "intervalId": "Months"
  },
  "patronBilledAfterAgedLost": {
    "duration": 12,
    "intervalId": "Months"
  },
  "chargeAmountItem": {
    "chargeType": "Actual cost",
    "amount": 5.00
  },
  "lostItemProcessingFee": 5.00,
  "chargeAmountItemPatron": true,
  "chargeAmountItemSystem": true,
  "lostItemChargeFeeFine": {
    "duration": 6,
    "intervalId": "Months"
  },
  "returnedLostItemProcessingFee": true,
  "replacedLostItemProcessingFee": true,
  "replacementProcessingFee": 0.00,
  "replacementAllowed": true,
  "lostItemReturned": "Charge",
  "id": "0c340536-8ed7-409e-8940-e65f2330d4d7"
}

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 lost-item-fees-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 lost-item-fees-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 /lost-item-fees-policies/{lostItemFeePolicyId}

Get Lost Item Fee Policy by id

GET /lost-item-fees-policies/{lostItemFeePolicyId}

URI Parameters

lostItemFeePolicyId: required (string)

Response 200

Return Lost Item Fee Policy

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "CRUD lost item fee policy schema",
  "description": "CRUD to lost item fee policies",
  "type": "object",
  "properties": {
    "name": {
      "description": "Lost item fee policy name, is a required field",
      "type": "string"
    },
    "description": {
      "description": "Lost item fee policy description",
      "type": "string"
    },
    "itemAgedLostOverdue": {
      "description": "Items aged to lost after overdue entered, must be 0 or > 0 and, if > 0 must have interval selected",
      "type": "object",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "properties": {
        "duration": {
          "description": "Duration of the number of times the interval repeats",
          "type": "integer",
          "minimum": 1
        },
        "intervalId": {
          "type": "string",
          "description": "Interval for the period, e.g. Hours, Days or Weeks",
          "enum": [
            "Minutes",
            "Hours",
            "Days",
            "Weeks",
            "Months",
            "Years"
          ]
        }
      },
      "additionalProperties": false
    },
    "patronBilledAfterAgedLost": {
      "description": "Patron billed after aged to lost entered, must be 0 or > 0 and, if > 0 must have interval selected",
      "type": "object",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "properties": {
        "duration": {
          "description": "Duration of the number of times the interval repeats",
          "type": "integer",
          "minimum": 1
        },
        "intervalId": {
          "type": "string",
          "description": "Interval for the period, e.g. Hours, Days or Weeks",
          "enum": [
            "Minutes",
            "Hours",
            "Days",
            "Weeks",
            "Months",
            "Years"
          ]
        }
      },
      "additionalProperties": false
    },
    "recalledItemAgedLostOverdue": {
      "description": "Recalled items aged to lost after overdue entered, must be 0 or > 0 and, if > 0 must have interval selected",
      "type": "object",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "properties": {
        "duration": {
          "description": "Duration of the number of times the interval repeats",
          "type": "integer",
          "minimum": 1
        },
        "intervalId": {
          "type": "string",
          "description": "Interval for the period, e.g. Hours, Days or Weeks",
          "enum": [
            "Minutes",
            "Hours",
            "Days",
            "Weeks",
            "Months",
            "Years"
          ]
        }
      },
      "additionalProperties": false
    },
    "patronBilledAfterRecalledItemAgedLost": {
      "description": "Patron billed after a recalled item aged to lost entered, must be 0 or > 0 and, if > 0 must have interval selected",
      "type": "object",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "properties": {
        "duration": {
          "description": "Duration of the number of times the interval repeats",
          "type": "integer",
          "minimum": 1
        },
        "intervalId": {
          "type": "string",
          "description": "Interval for the period, e.g. Hours, Days or Weeks",
          "enum": [
            "Minutes",
            "Hours",
            "Days",
            "Weeks",
            "Months",
            "Years"
          ]
        }
      },
      "additionalProperties": false
    },
    "chargeAmountItem": {
      "description": "Option to charge amount for item",
      "type": "object",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "properties": {
        "chargeType": {
          "description": "Charge type amount for item may be Actual cost or an amount",
          "type": "string"
        },
        "amount": {
          "description": "Charge amount for item may be Actual cost or an amount",
          "javaType": "org.folio.rest.domain.MonetaryValue",
          "type": "number"
        }
      },
      "additionalProperties": false
    },
    "lostItemProcessingFee": {
      "description": "Lost item processing fee, must be = 0 or > 0",
      "javaType": "org.folio.rest.domain.MonetaryValue",
      "type": "number"
    },
    "chargeAmountItemPatron": {
      "description": "A flag to determine charge lost item processing fee if item declared lost by patron must be Yes or No, with default set to Yes",
      "type": "boolean"
    },
    "chargeAmountItemSystem": {
      "description": "A flag to determine charge lost item processing fee if item aged to lost by system must be Yes or No, with default set to Yes",
      "type": "boolean"
    },
    "lostItemChargeFeeFine": {
      "description": "For items not charged a fee/fine, close the loan after entered, must be 0 or > 0 and, if > 0 must have interval selected",
      "type": "object",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "properties": {
        "duration": {
          "description": "Duration of the number of times the interval repeats",
          "type": "integer",
          "minimum": 1
        },
        "intervalId": {
          "type": "string",
          "description": "Interval for the period, e.g. Hours, Days or Weeks",
          "enum": [
            "Minutes",
            "Hours",
            "Days",
            "Weeks",
            "Months",
            "Years"
          ]
        }
      },
      "additionalProperties": false
    },
    "returnedLostItemProcessingFee": {
      "description": "A flag to determine if lost item returned, remove lost item processing fee",
      "type": "boolean"
    },
    "replacedLostItemProcessingFee": {
      "description": "A flag to determine if lost item replaced, remove lost item processing fee",
      "type": "boolean"
    },
    "replacementProcessingFee": {
      "description": "Amount for replacement process fee",
      "javaType": "org.folio.rest.domain.MonetaryValue",
      "type": "number"
    },
    "replacementAllowed": {
      "description": "A flag to determine replacement allowed",
      "type": "boolean"
    },
    "lostItemReturned": {
      "description": "Option to lost item returned may be Charge overdues based on returned date up to maximum (if applicable) or Remove overdue fines, with a default of _Charge overdues based on returned date up to maximum (if applicable)",
      "type": "string"
    },
    "feesFinesShallRefunded": {
      "description": "Fees/fines shall be refunded if a lost item is returned more than entered, must be 0 or > 0 and, if > 0 must have interval selected",
      "type": "object",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "properties": {
        "duration": {
          "description": "Duration of the number of times the interval repeats",
          "type": "integer",
          "minimum": 1
        },
        "intervalId": {
          "type": "string",
          "description": "Interval for the period, e.g. Hours, Days or Weeks",
          "enum": [
            "Minutes",
            "Hours",
            "Days",
            "Weeks",
            "Months",
            "Years"
          ]
        }
      },
      "additionalProperties": false
    },
    "metadata": {
      "description": "Metadata about creation to lost item fee 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": "Lost item fee 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": "Undergrad standard",
  "description": "This is description for undergrad standard",
  "itemAgedLostOverdue": {
    "duration": 12,
    "intervalId": "Months"
  },
  "patronBilledAfterAgedLost": {
    "duration": 12,
    "intervalId": "Months"
  },
  "chargeAmountItem": {
    "chargeType": "Actual cost",
    "amount": 5.00
  },
  "lostItemProcessingFee": 5.00,
  "chargeAmountItemPatron": true,
  "chargeAmountItemSystem": true,
  "lostItemChargeFeeFine": {
    "duration": 6,
    "intervalId": "Months"
  },
  "returnedLostItemProcessingFee": true,
  "replacedLostItemProcessingFee": true,
  "replacementProcessingFee": 0.00,
  "replacementAllowed": true,
  "lostItemReturned": "Charge",
  "id": "0c340536-8ed7-409e-8940-e65f2330d4d7"
}

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 /lost-item-fees-policies/{lostItemFeePolicyId}

Delete Lost Item Fee Policy by id

DELETE /lost-item-fees-policies/{lostItemFeePolicyId}

URI Parameters

lostItemFeePolicyId: 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 lostItemFeePolicyId

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 /lost-item-fees-policies/{lostItemFeePolicyId}

Update lost-item-fees-policy item with given {lost-item-fees-policyId}

PUT /lost-item-fees-policies/{lostItemFeePolicyId}

URI Parameters

lostItemFeePolicyId: required (string)

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "CRUD lost item fee policy schema",
  "description": "CRUD to lost item fee policies",
  "type": "object",
  "properties": {
    "name": {
      "description": "Lost item fee policy name, is a required field",
      "type": "string"
    },
    "description": {
      "description": "Lost item fee policy description",
      "type": "string"
    },
    "itemAgedLostOverdue": {
      "description": "Items aged to lost after overdue entered, must be 0 or > 0 and, if > 0 must have interval selected",
      "type": "object",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "properties": {
        "duration": {
          "description": "Duration of the number of times the interval repeats",
          "type": "integer",
          "minimum": 1
        },
        "intervalId": {
          "type": "string",
          "description": "Interval for the period, e.g. Hours, Days or Weeks",
          "enum": [
            "Minutes",
            "Hours",
            "Days",
            "Weeks",
            "Months",
            "Years"
          ]
        }
      },
      "additionalProperties": false
    },
    "patronBilledAfterAgedLost": {
      "description": "Patron billed after aged to lost entered, must be 0 or > 0 and, if > 0 must have interval selected",
      "type": "object",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "properties": {
        "duration": {
          "description": "Duration of the number of times the interval repeats",
          "type": "integer",
          "minimum": 1
        },
        "intervalId": {
          "type": "string",
          "description": "Interval for the period, e.g. Hours, Days or Weeks",
          "enum": [
            "Minutes",
            "Hours",
            "Days",
            "Weeks",
            "Months",
            "Years"
          ]
        }
      },
      "additionalProperties": false
    },
    "recalledItemAgedLostOverdue": {
      "description": "Recalled items aged to lost after overdue entered, must be 0 or > 0 and, if > 0 must have interval selected",
      "type": "object",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "properties": {
        "duration": {
          "description": "Duration of the number of times the interval repeats",
          "type": "integer",
          "minimum": 1
        },
        "intervalId": {
          "type": "string",
          "description": "Interval for the period, e.g. Hours, Days or Weeks",
          "enum": [
            "Minutes",
            "Hours",
            "Days",
            "Weeks",
            "Months",
            "Years"
          ]
        }
      },
      "additionalProperties": false
    },
    "patronBilledAfterRecalledItemAgedLost": {
      "description": "Patron billed after a recalled item aged to lost entered, must be 0 or > 0 and, if > 0 must have interval selected",
      "type": "object",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "properties": {
        "duration": {
          "description": "Duration of the number of times the interval repeats",
          "type": "integer",
          "minimum": 1
        },
        "intervalId": {
          "type": "string",
          "description": "Interval for the period, e.g. Hours, Days or Weeks",
          "enum": [
            "Minutes",
            "Hours",
            "Days",
            "Weeks",
            "Months",
            "Years"
          ]
        }
      },
      "additionalProperties": false
    },
    "chargeAmountItem": {
      "description": "Option to charge amount for item",
      "type": "object",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "properties": {
        "chargeType": {
          "description": "Charge type amount for item may be Actual cost or an amount",
          "type": "string"
        },
        "amount": {
          "description": "Charge amount for item may be Actual cost or an amount",
          "javaType": "org.folio.rest.domain.MonetaryValue",
          "type": "number"
        }
      },
      "additionalProperties": false
    },
    "lostItemProcessingFee": {
      "description": "Lost item processing fee, must be = 0 or > 0",
      "javaType": "org.folio.rest.domain.MonetaryValue",
      "type": "number"
    },
    "chargeAmountItemPatron": {
      "description": "A flag to determine charge lost item processing fee if item declared lost by patron must be Yes or No, with default set to Yes",
      "type": "boolean"
    },
    "chargeAmountItemSystem": {
      "description": "A flag to determine charge lost item processing fee if item aged to lost by system must be Yes or No, with default set to Yes",
      "type": "boolean"
    },
    "lostItemChargeFeeFine": {
      "description": "For items not charged a fee/fine, close the loan after entered, must be 0 or > 0 and, if > 0 must have interval selected",
      "type": "object",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "properties": {
        "duration": {
          "description": "Duration of the number of times the interval repeats",
          "type": "integer",
          "minimum": 1
        },
        "intervalId": {
          "type": "string",
          "description": "Interval for the period, e.g. Hours, Days or Weeks",
          "enum": [
            "Minutes",
            "Hours",
            "Days",
            "Weeks",
            "Months",
            "Years"
          ]
        }
      },
      "additionalProperties": false
    },
    "returnedLostItemProcessingFee": {
      "description": "A flag to determine if lost item returned, remove lost item processing fee",
      "type": "boolean"
    },
    "replacedLostItemProcessingFee": {
      "description": "A flag to determine if lost item replaced, remove lost item processing fee",
      "type": "boolean"
    },
    "replacementProcessingFee": {
      "description": "Amount for replacement process fee",
      "javaType": "org.folio.rest.domain.MonetaryValue",
      "type": "number"
    },
    "replacementAllowed": {
      "description": "A flag to determine replacement allowed",
      "type": "boolean"
    },
    "lostItemReturned": {
      "description": "Option to lost item returned may be Charge overdues based on returned date up to maximum (if applicable) or Remove overdue fines, with a default of _Charge overdues based on returned date up to maximum (if applicable)",
      "type": "string"
    },
    "feesFinesShallRefunded": {
      "description": "Fees/fines shall be refunded if a lost item is returned more than entered, must be 0 or > 0 and, if > 0 must have interval selected",
      "type": "object",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "properties": {
        "duration": {
          "description": "Duration of the number of times the interval repeats",
          "type": "integer",
          "minimum": 1
        },
        "intervalId": {
          "type": "string",
          "description": "Interval for the period, e.g. Hours, Days or Weeks",
          "enum": [
            "Minutes",
            "Hours",
            "Days",
            "Weeks",
            "Months",
            "Years"
          ]
        }
      },
      "additionalProperties": false
    },
    "metadata": {
      "description": "Metadata about creation to lost item fee 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": "Lost item fee 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": "Undergrad standard",
  "description": "This is description for undergrad standard",
  "itemAgedLostOverdue": {
    "duration": 12,
    "intervalId": "Months"
  },
  "patronBilledAfterAgedLost": {
    "duration": 12,
    "intervalId": "Months"
  },
  "chargeAmountItem": {
    "chargeType": "Actual cost",
    "amount": 5.00
  },
  "lostItemProcessingFee": 5.00,
  "chargeAmountItemPatron": true,
  "chargeAmountItemSystem": true,
  "lostItemChargeFeeFine": {
    "duration": 6,
    "intervalId": "Months"
  },
  "returnedLostItemProcessingFee": true,
  "replacedLostItemProcessingFee": true,
  "replacementProcessingFee": 0.00,
  "replacementAllowed": true,
  "lostItemReturned": "Charge",
  "id": "0c340536-8ed7-409e-8940-e65f2330d4d7"
}

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 lost-item-fees-policy -- malformed JSON at 13:4"

Response 404

Item with a given ID not found

Body

Media type: text/plain

Type: any

Example:

"lost-item-fees-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

Lost Item Fee Policies (v16.3)

Table of contents

Lost Item Fee Policies API

/lost-item-fees-policies

GET /lost-item-fees-policies

Query Parameters

Response 200

Response 400

Response 401

Response 500

POST /lost-item-fees-policies

Response 201

Headers

Response 400

Response 401

Response 422

Response 500

GET /lost-item-fees-policies/{lostItemFeePolicyId}

URI Parameters

Response 200

Response 404

Response 500

DELETE /lost-item-fees-policies/{lostItemFeePolicyId}

URI Parameters

Response 204

Response 400

Response 404

Response 500

PUT /lost-item-fees-policies/{lostItemFeePolicyId}

URI Parameters

Response 204

Response 400

Response 404

Response 409

Response 500