http://github.com/org/folio/mod-finc-config
This documents the API calls that can be made to query and manage EZB credentials for all tenants/isils
Collection of ezb-credential items.
Return a list of ezb credentials (credentials of all tenants)
GET /finc-config/ezb-credentialsA 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
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:
noneSkip over a number of elements by specifying an offset value for the query
Example:
0Limit 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:
10Returns a list of ezb-credential items
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"description": "Collection of EZB credentials",
"properties": {
"credentials": {
"type": "array",
"description": "List of EZB credentials",
"id": "credentials",
"items": {
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "EZB Credential",
"description": "Single EZB Credential schema",
"properties": {
"id": {
"description": "ID of cred entry.",
"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}$",
"readOnly": true
},
"user": {
"type": "string",
"description": "The user name"
},
"password": {
"type": "string",
"description": "The password"
},
"libId": {
"type": "string",
"description": "The library id"
},
"isil": {
"type": "string",
"description": "Isil of library of this credential entry. Needs to be unique. Hence, there is only one ezb credential per library."
}
},
"required": [
"user",
"password",
"libId"
]
}
},
"totalRecords": {
"type": "integer"
}
},
"required": [
"credentials",
"totalRecords"
]
}Example:
{
"credentials": [
{
"user": "user1",
"password": "password1",
"libId": "lib1",
"isil": "DE-14",
"id": "5da17580-5d30-4b75-aafb-1317bafad827"
},
{
"user": "user2",
"password": "password2",
"libId": "lib2",
"isil": "DE-15",
"id": "5da17580-5d30-4b75-aafb-1317bafad828"
}
],
"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 ezb-credentials -- malformed parameter 'query', syntax error at column 6Not authorized to perform requested action
Media type: text/plain
Type: any
Example:
unable to list ezb-credentials -- unauthorizedInternal server error, e.g. due to misconfiguration
Media type: text/plain
Type: any
Example:
internal server error, contact administratorCreate an ezb credential
POST /finc-config/ezb-credentialsMedia type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "EZB Credential",
"description": "Single EZB Credential schema",
"properties": {
"id": {
"description": "ID of cred entry.",
"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}$",
"readOnly": true
},
"user": {
"type": "string",
"description": "The user name"
},
"password": {
"type": "string",
"description": "The password"
},
"libId": {
"type": "string",
"description": "The library id"
},
"isil": {
"type": "string",
"description": "Isil of library of this credential entry. Needs to be unique. Hence, there is only one ezb credential per library."
}
},
"required": [
"user",
"password",
"libId"
]
}Example:
{
"user": "user1",
"password": "password1",
"libId": "lib1",
"isil": "DE-14",
"id": "5da17580-5d30-4b75-aafb-1317bafad827"
}Returns a newly created item, with server-controlled fields like 'id' populated
URI to the created ezb-credential item
Media type: application/json
Type: any
Example:
{
"user": "user1",
"password": "password1",
"libId": "lib1",
"isil": "DE-14",
"id": "5da17580-5d30-4b75-aafb-1317bafad827"
}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 ezb-credential -- malformed JSON at 13:3"
Not authorized to perform requested action
Media type: text/plain
Type: any
Example:
unable to create ezb-credentials -- unauthorizedValidation 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 administratorGet one ezb credentials entry by isil
GET /finc-config/ezb-credentials/{isil}Returns item with a given ID
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "EZB Credential",
"description": "Single EZB Credential schema",
"properties": {
"id": {
"description": "ID of cred entry.",
"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}$",
"readOnly": true
},
"user": {
"type": "string",
"description": "The user name"
},
"password": {
"type": "string",
"description": "The password"
},
"libId": {
"type": "string",
"description": "The library id"
},
"isil": {
"type": "string",
"description": "Isil of library of this credential entry. Needs to be unique. Hence, there is only one ezb credential per library."
}
},
"required": [
"user",
"password",
"libId"
]
}Example:
{
"user": "user1",
"password": "password1",
"libId": "lib1",
"isil": "DE-14",
"id": "5da17580-5d30-4b75-aafb-1317bafad827"
}Item with a given ID not found
Media type: text/plain
Type: any
Example:
"ezb-credential not found"
Internal server error, e.g. due to misconfiguration
Media type: text/plain
Type: any
Example:
internal server error, contact administratorDelete an ezb credentials entry identified by isil
DELETE /finc-config/ezb-credentials/{isil}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 ezb-credential -- constraint violation"
Item with a given ID not found
Media type: text/plain
Type: any
Example:
"ezb-credential not found"
Internal server error, e.g. due to misconfiguration
Media type: text/plain
Type: any
Example:
Internal server error, contact administratorPut an ezb credentials entry identified by isil
PUT /finc-config/ezb-credentials/{isil}Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "EZB Credential",
"description": "Single EZB Credential schema",
"properties": {
"id": {
"description": "ID of cred entry.",
"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}$",
"readOnly": true
},
"user": {
"type": "string",
"description": "The user name"
},
"password": {
"type": "string",
"description": "The password"
},
"libId": {
"type": "string",
"description": "The library id"
},
"isil": {
"type": "string",
"description": "Isil of library of this credential entry. Needs to be unique. Hence, there is only one ezb credential per library."
}
},
"required": [
"user",
"password",
"libId"
]
}Example:
{
"user": "user1",
"password": "password1",
"libId": "lib1",
"isil": "DE-14",
"id": "5da17580-5d30-4b75-aafb-1317bafad827"
}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 ezb-credential -- malformed JSON at 13:4"
Item with a given ID not found
Media type: text/plain
Type: any
Example:
"ezb-credential not found"
Optimistic locking version conflict
Media type: text/plain
Type: any
Example:
version conflictInternal server error, e.g. due to misconfiguration
Media type: text/plain
Type: any
Example:
internal server error, contact administrator