http://github.com/org/folio/mod-feesfines
This documents the API calls that can be made to query and manage feefine of the system
Collection of comment items.
Create a comment
POST /comments
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Comment required Settings schema",
"description": "Comment required for additional information on fees/fine transactions",
"type": "object",
"properties": {
"paid": {
"description": "A flag to determine when paying if it is mandatory to add additional information",
"type": "boolean"
},
"waived": {
"description": "A flag to determine when waiving if it is mandatory to add additional information",
"type": "boolean"
},
"refunded": {
"description": "A flag to determine when refunding if it is mandatory to add additional information",
"type": "boolean"
},
"transferredManually": {
"description": "A flag to determine when transferring if it is mandatory to add additional information",
"type": "boolean"
},
"metadata": {
"description": "Metadata about creation to comment required, 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": "Comment required 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
}
Example:
{
"paid": false,
"waived": true,
"refunded": true,
"transferredManually": true,
"metadata": {
"createdByUserId": "1ad737b0-d847-11e6-bf26-cec0c932ce01",
"createdDate": "2018-05-22T21:21:02Z"
},
"id": "0bab56e5-1ab6-4ac2-afdf-8b2df0434371"
}
Returns a newly created item, with server-controlled fields like 'id' populated
URI to the created comment item
Media type: application/json
Type: any
Example:
{
"paid": false,
"waived": true,
"refunded": true,
"transferredManually": true,
"metadata": {
"createdByUserId": "1ad737b0-d847-11e6-bf26-cec0c932ce01",
"createdDate": "2018-05-22T21:21:02Z"
},
"id": "0bab56e5-1ab6-4ac2-afdf-8b2df0434371"
}
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.
Media type: text/plain
Type: any
Example:
"unable to add comment -- malformed JSON at 13:3"
Not authorized to perform requested action
Media type: text/plain
Type: any
Example:
unable to create comments -- unauthorized
Validation errors
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"
}
]
}
]
}
Internal server error, e.g. due to misconfiguration
Media type: text/plain
Type: any
Example:
Internal server error, contact administrator
Get a single comment
GET /comments/{commentId}
Returns item with a given ID
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Comment required Settings schema",
"description": "Comment required for additional information on fees/fine transactions",
"type": "object",
"properties": {
"paid": {
"description": "A flag to determine when paying if it is mandatory to add additional information",
"type": "boolean"
},
"waived": {
"description": "A flag to determine when waiving if it is mandatory to add additional information",
"type": "boolean"
},
"refunded": {
"description": "A flag to determine when refunding if it is mandatory to add additional information",
"type": "boolean"
},
"transferredManually": {
"description": "A flag to determine when transferring if it is mandatory to add additional information",
"type": "boolean"
},
"metadata": {
"description": "Metadata about creation to comment required, 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": "Comment required 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
}
Example:
{
"paid": false,
"waived": true,
"refunded": true,
"transferredManually": true,
"metadata": {
"createdByUserId": "1ad737b0-d847-11e6-bf26-cec0c932ce01",
"createdDate": "2018-05-22T21:21:02Z"
},
"id": "0bab56e5-1ab6-4ac2-afdf-8b2df0434371"
}
Item with a given ID not found
Media type: text/plain
Type: any
Example:
"comment not found"
Internal server error, e.g. due to misconfiguration
Media type: text/plain
Type: any
Example:
internal server error, contact administrator
Delete comment item with given {commentId}
DELETE /comments/{commentId}
Item deleted successfully
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.
Media type: text/plain
Type: any
Example:
"unable to delete comment -- constraint violation"
Item with a given ID not found
Media type: text/plain
Type: any
Example:
"comment not found"
Internal server error, e.g. due to misconfiguration
Media type: text/plain
Type: any
Example:
Internal server error, contact administrator
Update comment item with given {commentId}
PUT /comments/{commentId}
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Comment required Settings schema",
"description": "Comment required for additional information on fees/fine transactions",
"type": "object",
"properties": {
"paid": {
"description": "A flag to determine when paying if it is mandatory to add additional information",
"type": "boolean"
},
"waived": {
"description": "A flag to determine when waiving if it is mandatory to add additional information",
"type": "boolean"
},
"refunded": {
"description": "A flag to determine when refunding if it is mandatory to add additional information",
"type": "boolean"
},
"transferredManually": {
"description": "A flag to determine when transferring if it is mandatory to add additional information",
"type": "boolean"
},
"metadata": {
"description": "Metadata about creation to comment required, 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": "Comment required 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
}
Example:
{
"paid": false,
"waived": true,
"refunded": true,
"transferredManually": true,
"metadata": {
"createdByUserId": "1ad737b0-d847-11e6-bf26-cec0c932ce01",
"createdDate": "2018-05-22T21:21:02Z"
},
"id": "0bab56e5-1ab6-4ac2-afdf-8b2df0434371"
}
Item successfully updated
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.
Media type: text/plain
Type: any
Example:
"unable to update comment -- malformed JSON at 13:4"
Item with a given ID not found
Media type: text/plain
Type: any
Example:
"comment not found"
Optimistic locking version conflict
Media type: text/plain
Type: any
Example:
version conflict
Internal server error, e.g. due to misconfiguration
Media type: text/plain
Type: any
Example:
internal server error, contact administrator
GET /comments
Return a list of comments
Query Parameters
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:
Order by field: field A, field B
Order
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:
Skip over a number of elements by specifying an offset value for the query
Example:
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:
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
Response 200
Returns a list of comment items
Body
Media type: application/json
Type: json
Content:
Example:
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:
Response 401
Not authorized to perform requested action
Body
Media type: text/plain
Type: any
Example:
Response 500
Internal server error, e.g. due to misconfiguration
Body
Media type: text/plain
Type: any
Example: