Finc Config EZB Credentials (v1)

http://github.com/org/folio/mod-finc-config

Table of contents

mod-finc-config EZB Credentials API

This documents the API calls that can be made to query and manage EZB credentials of the system

/finc-select/ezb-credentials

GET /finc-select/ezb-credentials

Get ezb credential entry

GET /finc-select/ezb-credentials

Response 200

The tenant's 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. Will be generated based on isil.",
      "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."
    }
  },
  "required": [
    "user",
    "password",
    "libId"
  ]
}

Example:

{
  "user": "user1",
  "password": "password1",
  "libId": "lib1",
  "isil": "DE-14",
  "id": "5da17580-5d30-4b75-aafb-1317bafad827"
}

Response 404

Not found

Body

Media type: text/plain

Type: any

Example:

Not found

Response 500

Internal server error

Body

Media type: text/plain

Type: any

Example:

Internal server error

PUT /finc-select/ezb-credentials

Add or edit an ezb credential entry

PUT /finc-select/ezb-credentials
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. Will be generated based on isil.",
      "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."
    }
  },
  "required": [
    "user",
    "password",
    "libId"
  ]
}

Response 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. Will be generated based on isil.",
      "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."
    }
  },
  "required": [
    "user",
    "password",
    "libId"
  ]
}

Example:

{
  "user": "user1",
  "password": "password1",
  "libId": "lib1",
  "isil": "DE-14",
  "id": "5da17580-5d30-4b75-aafb-1317bafad827"
}

Response 400

Bad request

Body

Media type: text/plain

Type: any

Example:

Bad request

Response 500

Internal server error

Body

Media type: text/plain

Type: any

Example:

Internal server error

DELETE /finc-select/ezb-credentials

Delete ezb credential

DELETE /finc-select/ezb-credentials

Response 204

Delete succeeded

Response 400

Bad request

Body

Media type: text/plain

Type: any

Response 500

Internal server error

Body

Media type: text/plain

Type: any

Example:

Internal server error, contact administrator