http://github.com/org/folio/mod-feesfines
This documents the API calls that can be made to query and manage owner of the system
Collection of owner items.
Return a list of owners
GET /owners
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
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:
none
Skip over a number of elements by specifying an offset value for the query
Example:
0
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
Returns a list of owner items
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Collection of owners",
"type": "object",
"properties": {
"owners": {
"description": "List of owner items",
"type": "array",
"id": "ownersData",
"items": {
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "CRUD Owner schema",
"description": "CRUD functions for Fee/Fine Owners",
"properties": {
"owner": {
"description": "Service desk (known as a fee/fine owner) is library-defined and is associated with specific fees/fines",
"type": "string"
},
"desc": {
"description": "Owner description",
"type": "string"
},
"servicePointOwner": {
"description": "Service points associated to a Owner",
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"description": "ID of the service-point",
"$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}$"
},
"label": {
"description": "Service-point name label",
"type": "string"
}
},
"required": [
"value"
]
}
},
"defaultChargeNoticeId": {
"description": "ID of the fee/fine charge template",
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "uuid.schema",
"type": "string",
"pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
},
"defaultActionNoticeId": {
"description": "ID of the fee/fine action template",
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "uuid.schema",
"type": "string",
"pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
},
"metadata": {
"description": "Metadata about creation to owner, 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": "Owner 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
}
},
"totalRecords": {
"type": "integer"
}
},
"required": [
"owners",
"totalRecords"
]
}
Example:
{
"owners": [
{
"owner": "Main Admin",
"desc": "Main Library Administration Office",
"servicePointOwner": [{
"value": "3a40852d-49fd-4df2-a1f9-6e2641a6e91f",
"label": "Main Lib Circ Desk"
}],
"defaultChargeNoticeId": "194918b2-477b-4184-9563-53ea9feb5006",
"defaultChargeActionId": "40c19f52-f2af-4019-bcda-d6d51ba6e3f2",
"metadata": {
"createdDate": "2018-05-22T21:21:02Z",
"createdByUserId": "1ad737b0-d847-11e6-bf26-cec0c932ce02",
"createdByUsername": "Doe",
"updatedDate": "2018-05-22T21:21:02Z",
"updatedByUserId": "695540df-cf63-4c67-91c1-d8746920d1dd",
"updatedByUsername": "robertjones"
},
"id": "8166df0e-36be-4bf8-8cb7-97b252d9989d"
}
],
"totalRecords": 1
}
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 list owners -- malformed parameter 'query', syntax error at column 6
Not authorized to perform requested action
Media type: text/plain
Type: any
Example:
unable to list owners -- unauthorized
Internal server error, e.g. due to misconfiguration
Media type: text/plain
Type: any
Example:
internal server error, contact administrator
Create a owner
POST /owners
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "CRUD Owner schema",
"description": "CRUD functions for Fee/Fine Owners",
"type": "object",
"properties": {
"owner": {
"description": "Service desk (known as a fee/fine owner) is library-defined and is associated with specific fees/fines",
"type": "string"
},
"desc": {
"description": "Owner description",
"type": "string"
},
"servicePointOwner": {
"description": "Service points associated to a Owner",
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"description": "ID of the service-point",
"$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}$"
},
"label": {
"description": "Service-point name label",
"type": "string"
}
},
"required": [
"value"
]
}
},
"defaultChargeNoticeId": {
"description": "ID of the fee/fine charge template",
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "uuid.schema",
"type": "string",
"pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
},
"defaultActionNoticeId": {
"description": "ID of the fee/fine action template",
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "uuid.schema",
"type": "string",
"pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
},
"metadata": {
"description": "Metadata about creation to owner, 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": "Owner 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:
{
"owner": "Main Circ",
"desc": "Main Library Circulation Desk",
"servicePointOwner": [{
"value": "3a40852d-49fd-4df2-a1f9-6e2641a6e91f",
"label": "Main Lib Circ Desk"
}],
"defaultChargeNoticeId": "194918b2-477b-4184-9563-53ea9feb5006",
"defaultActionNoticeId": "40c19f52-f2af-4019-bcda-d6d51ba6e3f2",
"metadata": {
"createdDate": "2018-05-22T21:21:02Z",
"createdByUserId": "1ad737b0-d847-11e6-bf26-cec0c932ce02",
"createdByUsername": "Doe",
"updatedDate": "2018-05-22T21:21:02Z",
"updatedByUserId": "695540df-cf63-4c67-91c1-d8746920d1dd",
"updatedByUsername": "robertjones"
},
"id": "8166df0e-36be-4bf8-8cb7-97b252d9989d"
}
Returns a newly created item, with server-controlled fields like 'id' populated
URI to the created owner item
Media type: application/json
Type: any
Example:
{
"owner": "Main Circ",
"desc": "Main Library Circulation Desk",
"servicePointOwner": [{
"value": "3a40852d-49fd-4df2-a1f9-6e2641a6e91f",
"label": "Main Lib Circ Desk"
}],
"defaultChargeNoticeId": "194918b2-477b-4184-9563-53ea9feb5006",
"defaultActionNoticeId": "40c19f52-f2af-4019-bcda-d6d51ba6e3f2",
"metadata": {
"createdDate": "2018-05-22T21:21:02Z",
"createdByUserId": "1ad737b0-d847-11e6-bf26-cec0c932ce02",
"createdByUsername": "Doe",
"updatedDate": "2018-05-22T21:21:02Z",
"updatedByUserId": "695540df-cf63-4c67-91c1-d8746920d1dd",
"updatedByUsername": "robertjones"
},
"id": "8166df0e-36be-4bf8-8cb7-97b252d9989d"
}
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 owner -- malformed JSON at 13:3"
Not authorized to perform requested action
Media type: text/plain
Type: any
Example:
unable to create owners -- 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 owner
GET /owners/{ownerId}
Returns item with a given ID
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "CRUD Owner schema",
"description": "CRUD functions for Fee/Fine Owners",
"type": "object",
"properties": {
"owner": {
"description": "Service desk (known as a fee/fine owner) is library-defined and is associated with specific fees/fines",
"type": "string"
},
"desc": {
"description": "Owner description",
"type": "string"
},
"servicePointOwner": {
"description": "Service points associated to a Owner",
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"description": "ID of the service-point",
"$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}$"
},
"label": {
"description": "Service-point name label",
"type": "string"
}
},
"required": [
"value"
]
}
},
"defaultChargeNoticeId": {
"description": "ID of the fee/fine charge template",
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "uuid.schema",
"type": "string",
"pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
},
"defaultActionNoticeId": {
"description": "ID of the fee/fine action template",
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "uuid.schema",
"type": "string",
"pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
},
"metadata": {
"description": "Metadata about creation to owner, 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": "Owner 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:
{
"owner": "Main Circ",
"desc": "Main Library Circulation Desk",
"servicePointOwner": [{
"value": "3a40852d-49fd-4df2-a1f9-6e2641a6e91f",
"label": "Main Lib Circ Desk"
}],
"defaultChargeNoticeId": "194918b2-477b-4184-9563-53ea9feb5006",
"defaultActionNoticeId": "40c19f52-f2af-4019-bcda-d6d51ba6e3f2",
"metadata": {
"createdDate": "2018-05-22T21:21:02Z",
"createdByUserId": "1ad737b0-d847-11e6-bf26-cec0c932ce02",
"createdByUsername": "Doe",
"updatedDate": "2018-05-22T21:21:02Z",
"updatedByUserId": "695540df-cf63-4c67-91c1-d8746920d1dd",
"updatedByUsername": "robertjones"
},
"id": "8166df0e-36be-4bf8-8cb7-97b252d9989d"
}
Item with a given ID not found
Media type: text/plain
Type: any
Example:
"owner not found"
Internal server error, e.g. due to misconfiguration
Media type: text/plain
Type: any
Example:
internal server error, contact administrator
Delete owner item with given {ownerId}
DELETE /owners/{ownerId}
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 owner -- constraint violation"
Item with a given ID not found
Media type: text/plain
Type: any
Example:
"owner not found"
Internal server error, e.g. due to misconfiguration
Media type: text/plain
Type: any
Example:
Internal server error, contact administrator
Update owner item with given {ownerId}
PUT /owners/{ownerId}
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "CRUD Owner schema",
"description": "CRUD functions for Fee/Fine Owners",
"type": "object",
"properties": {
"owner": {
"description": "Service desk (known as a fee/fine owner) is library-defined and is associated with specific fees/fines",
"type": "string"
},
"desc": {
"description": "Owner description",
"type": "string"
},
"servicePointOwner": {
"description": "Service points associated to a Owner",
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"description": "ID of the service-point",
"$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}$"
},
"label": {
"description": "Service-point name label",
"type": "string"
}
},
"required": [
"value"
]
}
},
"defaultChargeNoticeId": {
"description": "ID of the fee/fine charge template",
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "uuid.schema",
"type": "string",
"pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
},
"defaultActionNoticeId": {
"description": "ID of the fee/fine action template",
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "uuid.schema",
"type": "string",
"pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
},
"metadata": {
"description": "Metadata about creation to owner, 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": "Owner 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:
{
"owner": "Main Circ",
"desc": "Main Library Circulation Desk",
"servicePointOwner": [{
"value": "3a40852d-49fd-4df2-a1f9-6e2641a6e91f",
"label": "Main Lib Circ Desk"
}],
"defaultChargeNoticeId": "194918b2-477b-4184-9563-53ea9feb5006",
"defaultActionNoticeId": "40c19f52-f2af-4019-bcda-d6d51ba6e3f2",
"metadata": {
"createdDate": "2018-05-22T21:21:02Z",
"createdByUserId": "1ad737b0-d847-11e6-bf26-cec0c932ce02",
"createdByUsername": "Doe",
"updatedDate": "2018-05-22T21:21:02Z",
"updatedByUserId": "695540df-cf63-4c67-91c1-d8746920d1dd",
"updatedByUsername": "robertjones"
},
"id": "8166df0e-36be-4bf8-8cb7-97b252d9989d"
}
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 owner -- malformed JSON at 13:4"
Item with a given ID not found
Media type: text/plain
Type: any
Example:
"owner 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