Feefines version v1
http://github.com/org/folio/mod-feesfines
Feefines API
This documents the API calls that can be made to query and manage feefine of the system
/feefines
Collection of feefine items.
get
Return a list of feefines
post
Create a feefine
get /feefines
Return a list of feefines
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.
with valid searchable fields
Example:
(username=="ab*" or personal.firstName=="ab*" or personal.lastName=="ab*") and active=="true" sortby personal.lastName personal.firstName barcode active=true - orderBy: (string)
Order by field: field A, field B
- order: (one of desc, asc - default: desc)
Order
- 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
Example:
10 - facets: (array of )
facets to return in the collection result set, can be suffixed by a count of facet values to return, for example, patronGroup:10 default to top 5 facet values
- lang: (string - default: en - pattern: [a-zA-Z]{2})
Requested language. Optional. [lang=en]
HTTP status code 200
Returns a list of feefine items
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Collection of feesfines",
"type": "object",
"properties": {
"feefines": {
"description": "List of fee/fine items",
"type": "array",
"id": "feefinesData",
"items": {
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Manual Fees/Fines Table Settings schema",
"description": "Fees/fines that are used by the entire library system. They can be a set of fees / fines shared throughout the library or fees / fines that are unique to a specific customer service",
"properties": {
"automatic": {
"description": "A flag to indicate that fee/fine was created automatically.",
"type": "boolean",
"default": false
},
"feeFineType": {
"description": "Description of fee/fine that is up to the discretion of the user",
"type": "string"
},
"defaultAmount": {
"description": "Amount of fee or fine, which may be overridden. ",
"type": "number"
},
"chargeNoticeId": {
"description": "ID of the charge notice template",
"type": "string"
},
"actionNoticeId": {
"description": "ID of the action notice template",
"type": "string"
},
"ownerId": {
"description": "ID of the owner",
"type": "string"
},
"metadata": {
"description": "Metadata about creation to fee/fine, provided by the server",
"type": "object",
"$schema": "http://json-schema.org/draft-04/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": "Fee/fine id, UUID",
"type": "string"
}
},
"additionalProperties": false,
"required": [
"feeFineType",
"automatic"
]
}
},
"totalRecords": {
"type": "integer"
},
"resultInfo": {
"readonly": true,
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Faceting of result sets",
"type": "object",
"properties": {
"totalRecords": {
"type": "integer",
"description": "Estimated or exact total number of records"
},
"totalRecordsEstimated": {
"type": "boolean",
"description": "True if totalRecords is an estimation, false if it is the exact number"
},
"totalRecordsRounded": {
"type": "integer",
"description": "The rounded value of totalRecords if totalRecords is an estimation"
},
"responseTime": {
"type": "number",
"description": "Response time"
},
"facets": {
"type": "array",
"description": "Array of facets",
"items": {
"type": "object",
"description": "A facet",
"properties": {
"facetValues": {
"type": "array",
"description": "Array of facet values",
"items": {
"type": "object",
"description": "A facet value",
"properties": {
"count": {
"type": "integer",
"description": "Count of facet values"
},
"value": {
"description": "Value Object"
}
}
},
"additionalProperties": false
},
"type": {
"type": "string",
"description": "Type of facet"
}
},
"additionalProperties": false
}
},
"diagnostics": {
"type": "array",
"description": "Array of diagnostic information",
"items": {
"type": "object",
"description": "Diagnostic information",
"properties": {
"source": {
"type": "string",
"description": "Source reporting the diagnostic information"
},
"code": {
"type": "string",
"description": "Diagnostic Code"
},
"message": {
"type": "string",
"description": "Diagnostic Message"
},
"module": {
"type": "string",
"description": "Module reporting diagnostic information"
},
"recordCount": {
"type": "integer",
"description": "Record Count for diagnostics"
},
"query": {
"type": "string",
"description": "CQL Query associated with results"
}
}
}
}
},
"additionalProperties": false
}
},
"required": [
"feefines",
"totalRecords"
]
}Example:
{
"feefines":[
{
"feeFineType":"overdue",
"defaultAmount":100,
"chargeNoticeId": "09eb3fcb-eeec-4aca-a38e-3cbaac495cfc",
"actionNoticeId": "a8fcb171-5bd2-4913-97ef-4c7ed322b3ed",
"ownerId":"03ece16e-3fc6-4390-8511-ca7a7882c5c6",
"id":"39a14e03-c372-4659-860b-5423c970633e"
}
],
"totalRecords":1
}
HTTP status code 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 feefines -- malformed parameter 'query', syntax error at column 6HTTP status code 401
Not authorized to perform requested action
Body
Media type: text/plain
Type: any
Example:
unable to list feefines -- unauthorizedHTTP status code 500
Internal server error, e.g. due to misconfiguration
Body
Media type: text/plain
Type: any
Example:
internal server error, contact administratorpost /feefines
Create a feefine
Query Parameters
- lang: (string - default: en - pattern: [a-zA-Z]{2})
Requested language. Optional. [lang=en]
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Manual Fees/Fines Table Settings schema",
"description": "Fees/fines that are used by the entire library system. They can be a set of fees / fines shared throughout the library or fees / fines that are unique to a specific customer service",
"type": "object",
"properties": {
"automatic": {
"description": "A flag to indicate that fee/fine was created automatically.",
"type": "boolean",
"default": false
},
"feeFineType": {
"description": "Description of fee/fine that is up to the discretion of the user",
"type": "string"
},
"defaultAmount": {
"description": "Amount of fee or fine, which may be overridden. ",
"type": "number"
},
"chargeNoticeId": {
"description": "ID of the charge notice template",
"type": "string"
},
"actionNoticeId": {
"description": "ID of the action notice template",
"type": "string"
},
"ownerId": {
"description": "ID of the owner",
"type": "string"
},
"metadata": {
"description": "Metadata about creation to fee/fine, provided by the server",
"type": "object",
"$schema": "http://json-schema.org/draft-04/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": "Fee/fine id, UUID",
"type": "string"
}
},
"additionalProperties": false,
"required": [
"feeFineType",
"automatic"
]
}Example:
{
"feeFineType": "Overdue",
"defaultAmount": 100,
"chargeNoticeId": "09eb3fcb-eeec-4aca-a38e-3cbaac495cfc",
"actionNoticeId": "a8fcb171-5bd2-4913-97ef-4c7ed322b3ed",
"ownerId": "03ece16e-3fc6-4390-8511-ca7a7882c5c6",
"id": "39a14e03-c372-4659-860b-5423c970633e"
}
HTTP status code 201
Returns a newly created item, with server-controlled fields like 'id' populated
Headers
- Location: required(string)
URI to the created feefine item
Body
Media type: application/json
Type: any
Example:
{
"feeFineType": "Overdue",
"defaultAmount": 100,
"chargeNoticeId": "09eb3fcb-eeec-4aca-a38e-3cbaac495cfc",
"actionNoticeId": "a8fcb171-5bd2-4913-97ef-4c7ed322b3ed",
"ownerId": "03ece16e-3fc6-4390-8511-ca7a7882c5c6",
"id": "39a14e03-c372-4659-860b-5423c970633e"
}
HTTP status code 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 feefine -- malformed JSON at 13:3"
HTTP status code 401
Not authorized to perform requested action
Body
Media type: text/plain
Type: any
Example:
unable to create feefines -- unauthorizedHTTP status code 422
Validation errors
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/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#",
"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": {
"type": "object",
"description": "Error message parameters",
"$schema": "http://json-schema.org/draft-04/schema#",
"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"
}
]
}
]
}
HTTP status code 500
Internal server error, e.g. due to misconfiguration
Body
Media type: text/plain
Type: any
Example:
Internal server error, contact administratorEntity representing a feefine
get
Get a single feefine
delete
Delete feefine item with given {feefineId}
put
Update feefine item with given {feefineId}
get /feefines/{feefineId}
Get a single feefine
URI Parameters
- feefineId: required(string)
Query Parameters
- lang: (string - default: en - pattern: [a-zA-Z]{2})
Requested language. Optional. [lang=en]
HTTP status code 200
Returns item with a given ID
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Manual Fees/Fines Table Settings schema",
"description": "Fees/fines that are used by the entire library system. They can be a set of fees / fines shared throughout the library or fees / fines that are unique to a specific customer service",
"type": "object",
"properties": {
"automatic": {
"description": "A flag to indicate that fee/fine was created automatically.",
"type": "boolean",
"default": false
},
"feeFineType": {
"description": "Description of fee/fine that is up to the discretion of the user",
"type": "string"
},
"defaultAmount": {
"description": "Amount of fee or fine, which may be overridden. ",
"type": "number"
},
"chargeNoticeId": {
"description": "ID of the charge notice template",
"type": "string"
},
"actionNoticeId": {
"description": "ID of the action notice template",
"type": "string"
},
"ownerId": {
"description": "ID of the owner",
"type": "string"
},
"metadata": {
"description": "Metadata about creation to fee/fine, provided by the server",
"type": "object",
"$schema": "http://json-schema.org/draft-04/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": "Fee/fine id, UUID",
"type": "string"
}
},
"additionalProperties": false,
"required": [
"feeFineType",
"automatic"
]
}Example:
{
"feeFineType": "Overdue",
"defaultAmount": 100,
"chargeNoticeId": "09eb3fcb-eeec-4aca-a38e-3cbaac495cfc",
"actionNoticeId": "a8fcb171-5bd2-4913-97ef-4c7ed322b3ed",
"ownerId": "03ece16e-3fc6-4390-8511-ca7a7882c5c6",
"id": "39a14e03-c372-4659-860b-5423c970633e"
}
HTTP status code 404
Item with a given ID not found
Body
Media type: text/plain
Type: any
Example:
"feefine not found"
HTTP status code 500
Internal server error, e.g. due to misconfiguration
Body
Media type: text/plain
Type: any
Example:
internal server error, contact administratordelete /feefines/{feefineId}
Delete feefine item with given {feefineId}
URI Parameters
- feefineId: required(string)
Query Parameters
- lang: (string - default: en - pattern: [a-zA-Z]{2})
Requested language. Optional. [lang=en]
HTTP status code 204
Item deleted successfully
HTTP status code 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 delete feefine -- constraint violation"
HTTP status code 404
Item with a given ID not found
Body
Media type: text/plain
Type: any
Example:
"feefine not found"
HTTP status code 500
Internal server error, e.g. due to misconfiguration
Body
Media type: text/plain
Type: any
Example:
Internal server error, contact administratorput /feefines/{feefineId}
Update feefine item with given {feefineId}
URI Parameters
- feefineId: required(string)
Query Parameters
- lang: (string - default: en - pattern: [a-zA-Z]{2})
Requested language. Optional. [lang=en]
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Manual Fees/Fines Table Settings schema",
"description": "Fees/fines that are used by the entire library system. They can be a set of fees / fines shared throughout the library or fees / fines that are unique to a specific customer service",
"type": "object",
"properties": {
"automatic": {
"description": "A flag to indicate that fee/fine was created automatically.",
"type": "boolean",
"default": false
},
"feeFineType": {
"description": "Description of fee/fine that is up to the discretion of the user",
"type": "string"
},
"defaultAmount": {
"description": "Amount of fee or fine, which may be overridden. ",
"type": "number"
},
"chargeNoticeId": {
"description": "ID of the charge notice template",
"type": "string"
},
"actionNoticeId": {
"description": "ID of the action notice template",
"type": "string"
},
"ownerId": {
"description": "ID of the owner",
"type": "string"
},
"metadata": {
"description": "Metadata about creation to fee/fine, provided by the server",
"type": "object",
"$schema": "http://json-schema.org/draft-04/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": "Fee/fine id, UUID",
"type": "string"
}
},
"additionalProperties": false,
"required": [
"feeFineType",
"automatic"
]
}Example:
{
"feeFineType": "Overdue",
"defaultAmount": 100,
"chargeNoticeId": "09eb3fcb-eeec-4aca-a38e-3cbaac495cfc",
"actionNoticeId": "a8fcb171-5bd2-4913-97ef-4c7ed322b3ed",
"ownerId": "03ece16e-3fc6-4390-8511-ca7a7882c5c6",
"id": "39a14e03-c372-4659-860b-5423c970633e"
}
HTTP status code 204
Item successfully updated
HTTP status code 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 feefine -- malformed JSON at 13:4"
HTTP status code 404
Item with a given ID not found
Body
Media type: text/plain
Type: any
Example:
"feefine not found"
HTTP status code 500
Internal server error, e.g. due to misconfiguration
Body
Media type: text/plain
Type: any
Example:
internal server error, contact administrator