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 /ownersA 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
Skip over a number of elements by specifying an offset value for the query
Example:
0Limit the number of elements returned in the response
Example:
10Requested language. Optional. [lang=en]
Returns a list of owner items
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"owners": {
"type": "array",
"id": "ownersData",
"items": {
"type": "object",
"$ref": "ownerdata.json"
}
},
"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 6Not authorized to perform requested action
Media type: text/plain
Type: any
Example:
unable to list owners -- unauthorizedInternal server error, e.g. due to misconfiguration
Media type: text/plain
Type: any
Example:
internal server error, contact administratorCreate a owner
POST /ownersRequested language. Optional. [lang=en]
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Owner Schema",
"type": "object",
"properties": {
"owner": {
"type": "string"
},
"desc": {
"type": "string"
},
"servicePointOwner": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string"
},
"label": {
"type": "string"
}
},
"required": [
"value"
]
}
},
"defaultChargeNoticeId": {
"type": "string"
},
"defaultActionNoticeId": {
"type": "string"
},
"metadata" : {
"type" : "object",
"$ref" : "raml-util/schemas/metadata.schema"
},
"id": {
"type": "string"
}
},
"additionalProperties": false,
"required": [
"id"
]
}
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",
"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"
}
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",
"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"
}
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 -- unauthorizedValidation errors
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",
"$ref": "error.schema"
}
},
"total_records": {
"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 administratorGet a single owner
GET /owners/{ownerId}Requested language. Optional. [lang=en]
Returns item with a given ID
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Owner Schema",
"type": "object",
"properties": {
"owner": {
"type": "string"
},
"desc": {
"type": "string"
},
"servicePointOwner": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string"
},
"label": {
"type": "string"
}
},
"required": [
"value"
]
}
},
"defaultChargeNoticeId": {
"type": "string"
},
"defaultActionNoticeId": {
"type": "string"
},
"metadata" : {
"type" : "object",
"$ref" : "raml-util/schemas/metadata.schema"
},
"id": {
"type": "string"
}
},
"additionalProperties": false,
"required": [
"id"
]
}
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",
"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"
}
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 administratorDelete owner item with given {ownerId}
DELETE /owners/{ownerId}Requested language. Optional. [lang=en]
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 administratorUpdate owner item with given {ownerId}
PUT /owners/{ownerId}Requested language. Optional. [lang=en]
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Owner Schema",
"type": "object",
"properties": {
"owner": {
"type": "string"
},
"desc": {
"type": "string"
},
"servicePointOwner": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string"
},
"label": {
"type": "string"
}
},
"required": [
"value"
]
}
},
"defaultChargeNoticeId": {
"type": "string"
},
"defaultActionNoticeId": {
"type": "string"
},
"metadata" : {
"type" : "object",
"$ref" : "raml-util/schemas/metadata.schema"
},
"id": {
"type": "string"
}
},
"additionalProperties": false,
"required": [
"id"
]
}
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",
"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"
}
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"
Internal server error, e.g. due to misconfiguration
Media type: text/plain
Type: any
Example:
internal server error, contact administrator