Finc Config EZB Credentials version v2
http://github.com/org/folio/mod-finc-config
mod-finc-config EZB Credentials API
This documents the API calls that can be made to query and manage EZB credentials for the current tenant/isil
/finc-select/ezb-credentials
Get the ezb credentials of current tenant. Returns JSON null if no credentials have been configured yet.
Add or edit an ezb credential entry
Delete ezb credential
get /finc-select/ezb-credentials
Get the ezb credentials of current tenant. Returns JSON null if no credentials have been configured yet.
HTTP status code 200
The tenant's ezb credential entry, or JSON null if not configured
Body
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"
}HTTP status code 500
Internal server error
Body
Media type: text/plain
Type: any
Example:
Internal server errorput /finc-select/ezb-credentials
Add or edit an ezb credential entry
Body
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"
]
}HTTP status code 200
The added collections
Body
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"
}HTTP status code 400
Bad request
Body
Media type: text/plain
Type: any
Example:
Bad requestHTTP status code 500
Internal server error
Body
Media type: text/plain
Type: any
Example:
Internal server error