http://github.com/org/folio/mod-inventory-storage
This documents the API calls that can be made to query and manage ILL policies of the system
Collection of ill-policy items.
Return a list of ILL policy types
GET /ill-policiesA 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
name=aaa
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 ill-policy items
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "A collection of ILL policies",
"type": "object",
"properties": {
"illPolicies": {
"description": "List of ILL policies",
"id": "illPolicy",
"type": "array",
"items": {
"type": "object",
"$ref": "illpolicy.json"
}
},
"totalRecords": {
"type": "integer"
}
},
"required": [
"illPolicies",
"totalRecords"
]
}
Example:
{
"id": "596c920f-f33e-4bee-b8bc-98bb2bbc4978",
"name": "Will lend",
"source": "folio"
},
{
"id": "38852045-aeed-45b4-ac02-db44fd09798e",
"name": "Will not lend",
"source": "folio"
}
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 ill-policies -- malformed parameter 'query', syntax error at column 6Not authorized to perform requested action
Media type: text/plain
Type: any
Example:
unable to list ill-policies -- unauthorizedInternal server error, e.g. due to misconfiguration
Media type: text/plain
Type: any
Example:
internal server error, contact administratorCreate a new ILL policy
POST /ill-policiesRequested language. Optional. [lang=en]
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "An ILL policy",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "unique ID of the ILL policy; UUID"
},
"name": {
"type": "string",
"description": "name of the policy"
},
"source": {
"type": "string",
"description": "label indicating where the ILL policy entry originates from, i.e. 'folio' or 'local'"
},
"metadata": {
"type": "object",
"$ref": "raml-util/schemas/metadata.schema",
"readonly": true
}
},
"additionalProperties": false,
"required": [
"name",
"source"
]
}Example:
{
"id": "596c920f-f33e-4bee-b8bc-98bb2bbc4978",
"name": "Will lend",
"source": "folio"
}
Returns a newly created item, with server-controlled fields like 'id' populated
URI to the created ill-policy item
Media type: application/json
Type: any
Example:
{
"id": "596c920f-f33e-4bee-b8bc-98bb2bbc4978",
"name": "Will lend",
"source": "folio"
}
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 ill-policy -- malformed JSON at 13:3"
Not authorized to perform requested action
Media type: text/plain
Type: any
Example:
unable to create ill-policies -- unauthorizedValidation errors
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"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 administratorRetrieve ill-policy item with given {ill-policyId}
GET /ill-policies/{id}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#",
"description": "An ILL policy",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "unique ID of the ILL policy; UUID"
},
"name": {
"type": "string",
"description": "name of the policy"
},
"source": {
"type": "string",
"description": "label indicating where the ILL policy entry originates from, i.e. 'folio' or 'local'"
},
"metadata": {
"type": "object",
"$ref": "raml-util/schemas/metadata.schema",
"readonly": true
}
},
"additionalProperties": false,
"required": [
"name",
"source"
]
}Example:
{
"id": "596c920f-f33e-4bee-b8bc-98bb2bbc4978",
"name": "Will lend",
"source": "folio"
}
Item with a given ID not found
Media type: text/plain
Type: any
Example:
"ill-policy not found"
Internal server error, e.g. due to misconfiguration
Media type: text/plain
Type: any
Example:
internal server error, contact administratorDelete ill-policy item with given {ill-policyId}
DELETE /ill-policies/{id}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 ill-policy -- constraint violation"
Item with a given ID not found
Media type: text/plain
Type: any
Example:
"ill-policy not found"
Internal server error, e.g. due to misconfiguration
Media type: text/plain
Type: any
Example:
Internal server error, contact administratorUpdate ill-policy item with given {ill-policyId}
PUT /ill-policies/{id}Requested language. Optional. [lang=en]
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "An ILL policy",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "unique ID of the ILL policy; UUID"
},
"name": {
"type": "string",
"description": "name of the policy"
},
"source": {
"type": "string",
"description": "label indicating where the ILL policy entry originates from, i.e. 'folio' or 'local'"
},
"metadata": {
"type": "object",
"$ref": "raml-util/schemas/metadata.schema",
"readonly": true
}
},
"additionalProperties": false,
"required": [
"name",
"source"
]
}Example:
{
"id": "596c920f-f33e-4bee-b8bc-98bb2bbc4978",
"name": "Will lend",
"source": "folio"
}
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 ill-policy -- malformed JSON at 13:4"
Item with a given ID not found
Media type: text/plain
Type: any
Example:
"ill-policy not found"
Internal server error, e.g. due to misconfiguration
Media type: text/plain
Type: any
Example:
internal server error, contact administrator