http://github.com/org/folio/mod-finc-config
This documents the API calls that can be made to query and manage isils of the system
Collection of isil items.
Return a list of isisls
GET /finc-config/isilsA 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.
Example:
(username=="ab*" or personal.firstName=="ab*" or personal.lastName=="ab*") and active=="true" sortby personal.lastName personal.firstName barcode
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 isil items
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"description": "Collection of isil to tenant configurations",
"properties": {
"isils": {
"description": "List of isil items",
"id": "isils",
"type": "array",
"items": {
"type": "object",
"$ref": "isil.json"
}
},
"totalRecords": {
"type": "integer"
}
}
}
Example:
{
"isils": [
{
"library": "UB Leipzig",
"isil": "DE-15",
"tenant": "ubl",
"id": "5da17580-5d30-4b75-aafb-1317bafad827"
},
{
"library": "SLUB Dresden",
"isil": "DE-14",
"tenant": "slub",
"id": "8d7bc408-4ce9-4bba-992b-bc2118366faf"
}
],
"totalRecords": 2
}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 isils -- malformed parameter 'query', syntax error at column 6Not authorized to perform requested action
Media type: text/plain
Type: any
Example:
unable to list isils -- unauthorizedInternal server error, e.g. due to misconfiguration
Media type: text/plain
Type: any
Example:
internal server error, contact administratorCreate an isil
POST /finc-config/isilsRequested language. Optional. [lang=en]
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "Isil",
"description": "Isil to tenant configuration",
"properties": {
"id": {
"description": "A UUID identifying this group",
"type": "string"
},
"library": {
"description": "Descriptive name of the library",
"type": "string"
},
"isil": {
"description": "Isil of this library",
"type": "string"
},
"tenant": {
"description": "Tenant of this library",
"type": "string"
},
"metadata": {
"$ref": "../raml-util/schemas/metadata.schema",
"readonly": true
}
},
"required": [
"library",
"isil",
"tenant"
]
}
Example:
{
"id": "5da17580-5d30-4b75-aafb-1317bafad827",
"library": "UB Leipzig",
"isil": "DE-15",
"tenant": "ubl"
}
Returns a newly created item, with server-controlled fields like 'id' populated
URI to the created isil item
Media type: application/json
Type: any
Example:
{
"id": "5da17580-5d30-4b75-aafb-1317bafad827",
"library": "UB Leipzig",
"isil": "DE-15",
"tenant": "ubl"
}
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 isil -- malformed JSON at 13:3"
Not authorized to perform requested action
Media type: text/plain
Type: any
Example:
unable to create isils -- 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 administratorRetrieve isil item with given {isilId}
GET /finc-config/isils/{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#",
"type": "object",
"title": "Isil",
"description": "Isil to tenant configuration",
"properties": {
"id": {
"description": "A UUID identifying this group",
"type": "string"
},
"library": {
"description": "Descriptive name of the library",
"type": "string"
},
"isil": {
"description": "Isil of this library",
"type": "string"
},
"tenant": {
"description": "Tenant of this library",
"type": "string"
},
"metadata": {
"$ref": "../raml-util/schemas/metadata.schema",
"readonly": true
}
},
"required": [
"library",
"isil",
"tenant"
]
}
Example:
{
"id": "5da17580-5d30-4b75-aafb-1317bafad827",
"library": "UB Leipzig",
"isil": "DE-15",
"tenant": "ubl"
}
Item with a given ID not found
Media type: text/plain
Type: any
Example:
"isil not found"
Internal server error, e.g. due to misconfiguration
Media type: text/plain
Type: any
Example:
internal server error, contact administratorDelete isil item with given {isilId}
DELETE /finc-config/isils/{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 isil -- constraint violation"
Item with a given ID not found
Media type: text/plain
Type: any
Example:
"isil not found"
Internal server error, e.g. due to misconfiguration
Media type: text/plain
Type: any
Example:
Internal server error, contact administratorUpdate isil item with given {isilId}
PUT /finc-config/isils/{id}Requested language. Optional. [lang=en]
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "Isil",
"description": "Isil to tenant configuration",
"properties": {
"id": {
"description": "A UUID identifying this group",
"type": "string"
},
"library": {
"description": "Descriptive name of the library",
"type": "string"
},
"isil": {
"description": "Isil of this library",
"type": "string"
},
"tenant": {
"description": "Tenant of this library",
"type": "string"
},
"metadata": {
"$ref": "../raml-util/schemas/metadata.schema",
"readonly": true
}
},
"required": [
"library",
"isil",
"tenant"
]
}
Example:
{
"id": "5da17580-5d30-4b75-aafb-1317bafad827",
"library": "UB Leipzig",
"isil": "DE-15",
"tenant": "ubl"
}
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 isil -- malformed JSON at 13:4"
Item with a given ID not found
Media type: text/plain
Type: any
Example:
"isil not found"
Internal server error, e.g. due to misconfiguration
Media type: text/plain
Type: any
Example:
internal server error, contact administrator