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-config/ezb-credentials

Collection of ezb-credential items.

GET /finc-config/ezb-credentials

Return a list of isisls

GET /finc-config/ezb-credentials
Query Parameters
  • query: (string)

    A 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
  • offset: (integer - default: 0 - minimum: 0 - maximum: 2147483647)

    Skip over a number of elements by specifying an offset value for the query

    Example:

    0
  • limit: (integer - default: 10 - minimum: 0 - maximum: 2147483647)

    Limit the number of elements returned in the response

    Example:

    10
  • lang: (string - default: en - pattern: [a-zA-Z]{2})

    Requested language. Optional. [lang=en]

Response 200

Returns a list of ezb-credential items

Body

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. 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"
        ]
      }
    },
    "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
}

Response 400

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.

Body

Media type: text/plain

Type: any

Example:

unable to list ezb-credentials -- malformed parameter 'query', syntax error at column 6

Response 401

Not authorized to perform requested action

Body

Media type: text/plain

Type: any

Example:

unable to list ezb-credentials -- unauthorized

Response 500

Internal server error, e.g. due to misconfiguration

Body

Media type: text/plain

Type: any

Example:

internal server error, contact administrator

POST /finc-config/ezb-credentials

Create an isil

POST /finc-config/ezb-credentials
Query Parameters
  • lang: (string - default: en - pattern: [a-zA-Z]{2})

    Requested language. Optional. [lang=en]

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 201

Returns a newly created item, with server-controlled fields like 'id' populated

Headers
  • Location: required (string)

    URI to the created ezb-credential item

Body

Media type: application/json

Type: any

Example:

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

Response 400

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.

Body

Media type: text/plain

Type: any

Example:

"unable to add ezb-credential -- malformed JSON at 13:3"

Response 401

Not authorized to perform requested action

Body

Media type: text/plain

Type: any

Example:

unable to create ezb-credentials -- unauthorized

Response 422

Validation errors

Body

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"
        }
      ]
    }
  ]
}

Response 500

Internal server error, e.g. due to misconfiguration

Body

Media type: text/plain

Type: any

Example:

Internal server error, contact administrator

GET /finc-config/ezb-credentials/{isil}

Get one ezb credentials entry by isil

GET /finc-config/ezb-credentials/{isil}
URI Parameters
  • isil: required (string)
Query Parameters
  • lang: (string - default: en - pattern: [a-zA-Z]{2})

    Requested language. Optional. [lang=en]

Response 200

Returns item with a given ID

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

Item with a given ID not found

Body

Media type: text/plain

Type: any

Example:

"ezb-credential not found"

Response 500

Internal server error, e.g. due to misconfiguration

Body

Media type: text/plain

Type: any

Example:

internal server error, contact administrator

DELETE /finc-config/ezb-credentials/{isil}

Delete an ezb credentials entry identified by isil

DELETE /finc-config/ezb-credentials/{isil}
URI Parameters
  • isil: required (string)
Query Parameters
  • lang: (string - default: en - pattern: [a-zA-Z]{2})

    Requested language. Optional. [lang=en]

Response 204

Item deleted successfully

Response 400

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.

Body

Media type: text/plain

Type: any

Example:

"unable to delete ezb-credential -- constraint violation"

Response 404

Item with a given ID not found

Body

Media type: text/plain

Type: any

Example:

"ezb-credential not found"

Response 500

Internal server error, e.g. due to misconfiguration

Body

Media type: text/plain

Type: any

Example:

Internal server error, contact administrator

PUT /finc-config/ezb-credentials/{isil}

Put an ezb credentials entry identified by isil

PUT /finc-config/ezb-credentials/{isil}
URI Parameters
  • isil: required (string)
Query Parameters
  • lang: (string - default: en - pattern: [a-zA-Z]{2})

    Requested language. Optional. [lang=en]

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 204

Item successfully updated

Response 400

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.

Body

Media type: text/plain

Type: any

Example:

"unable to update ezb-credential -- malformed JSON at 13:4"

Response 404

Item with a given ID not found

Body

Media type: text/plain

Type: any

Example:

"ezb-credential not found"

Response 500

Internal server error, e.g. due to misconfiguration

Body

Media type: text/plain

Type: any

Example:

internal server error, contact administrator