foliolib.folio.api.kbEbscoJava.KbCredentials

class foliolib.folio.api.kbEbscoJava.KbCredentials(tenant: str)

Bases: foliolib.folio.FolioApi

mod-kb-ebsco-java

Implements the eholdings interface using EBSCO KB as backend.

Base class of the Folio API

Parameters: tenant (str) – Tenant id

Methods

`delete_kbCredential`(kbCredentialsId)	Delete KB Credentials
`get_kbCredential`(kbCredentialsId)	Get a specific KB credentials by id.
`get_kbCredentials`()	Get a collection of KB credentials.
`get_key_by_kbCredential`(kbCredentialsId)	Get a specific KB credentials key by id.
`get_userKbCredentials`()	Retrieve KB credentials by given assigned user
`modify_kbCredential`(kbCredentialsId, ...)	Update KB credentials
`set_kbCredential`(kbCredential)	Create KB credentials

delete_kbCredential(kbCredentialsId: str)

Delete KB Credentials

DELETE /eholdings/kb-credentials/{kbCredentialsId}

Parameters

kbCredentialsId (str) –

Raises

OkapiRequestUnauthorized – Authentication is required
OkapiRequestError – Bad Request
OkapiRequestFatalError – Server Error

get_kbCredential(kbCredentialsId: str)

Get a specific KB credentials by id.

GET /eholdings/kb-credentials/{kbCredentialsId}

Parameters

kbCredentialsId (str) –

Returns

See Schema below

Return type

dict

Raises

OkapiRequestUnauthorized – Authentication is required
OkapiRequestError – Bad Request
OkapiRequestNotFound – Not Found
OkapiRequestFatalError – Server Error

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "KB Credentials Collection Item Schema",
  "description": "KB Credentials Collection Item Schema",
  "javaType": "org.folio.rest.jaxrs.model.KbCredentials",
  "additionalProperties": false,
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "The UUID of entry",
      "$ref": "../../raml-util/schemas/uuid.schema",
      "examples": "2ffa1940-2cf6-48b1-8cc9-5e539c61d93f"
    },
    "type": {
      "type": "string",
      "description": "Type of resource",
      "enum": [
        "kbCredentials"
      ],
      "example": "kbCredentials"
    },
    "attributes": {
      "type": "object",
      "description": "KB credentials collection item attributes",
      "$ref": "kbCredentialsDataAttributes.json"
    },
    "meta": {
      "type": "object",
      "description": "Metadata about creation and changes to item",
      "$ref": "../../raml-util/schemas/metadata.schema",
      "readonly": true
    }
  },
  "required": [
    "type",
    "attributes"
  ]
}

get_kbCredentials()

Get a collection of KB credentials.

GET /eholdings/kb-credentials

Returns

See Schema below

Return type

dict

Raises

OkapiRequestUnauthorized – Authentication is required
OkapiRequestFatalError – Server Error

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "KB Credentials Collection Schema",
  "description": "KB Credentials Collection Schema",
  "javaType": "org.folio.rest.jaxrs.model.KbCredentialsCollection",
  "additionalProperties": false,
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "description": "Collection of KB Credentials",
      "items": {
        "type": "object",
        "$ref": "kbCredentials.json"
      }
    },
    "meta": {
      "type": "object",
      "description": "Metadata containing total size of collection",
      "$ref": "../metaTotalResults.json",
      "readonly": true
    },
    "jsonapi": {
      "type": "object",
      "description": "Version of JSON:API",
      "$ref": "../jsonapi.json"
    }
  },
  "required": [
    "data",
    "meta",
    "jsonapi"
  ]
}

get_key_by_kbCredential(kbCredentialsId: str)

Get a specific KB credentials key by id.

GET /eholdings/kb-credentials/{kbCredentialsId}/key

Parameters

kbCredentialsId (str) –

Returns

See Schema below

Return type

dict

Raises

OkapiRequestError – Bad Request
OkapiRequestNotFound – Not Found

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "KB Credentials Key Schema",
  "description": "KB Credentials Key Schema",
  "javaType": "org.folio.rest.jaxrs.model.KbCredentialsKey",
  "additionalProperties": false,
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "The UUID of entry",
      "$ref": "../../raml-util/schemas/uuid.schema",
      "examples": "2ffa1940-2cf6-48b1-8cc9-5e539c61d93f"
    },
    "type": {
      "type": "string",
      "description": "Type of resource",
      "enum": [
        "kbCredentialsKey"
      ],
      "example": "kbCredentialsKey"
    },
    "attributes": {
      "type": "object",
      "description": "KB credentials collection item attributes",
      "$ref": "kbCredentialsKeyDataAttributes.json"
    }
  },
  "required": [
    "type",
    "attributes"
  ]
}

get_userKbCredentials()

Retrieve KB credentials by given assigned user

GET /eholdings/user-kb-credential

Returns: See Schema below
Return type: dict
Raises: OkapiRequestNotFound – Not Found

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "KB Credentials Collection Item Schema",
  "description": "KB Credentials Collection Item Schema",
  "javaType": "org.folio.rest.jaxrs.model.KbCredentials",
  "additionalProperties": false,
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "The UUID of entry",
      "$ref": "../../raml-util/schemas/uuid.schema",
      "examples": "2ffa1940-2cf6-48b1-8cc9-5e539c61d93f"
    },
    "type": {
      "type": "string",
      "description": "Type of resource",
      "enum": [
        "kbCredentials"
      ],
      "example": "kbCredentials"
    },
    "attributes": {
      "type": "object",
      "description": "KB credentials collection item attributes",
      "$ref": "kbCredentialsDataAttributes.json"
    },
    "meta": {
      "type": "object",
      "description": "Metadata about creation and changes to item",
      "$ref": "../../raml-util/schemas/metadata.schema",
      "readonly": true
    }
  },
  "required": [
    "type",
    "attributes"
  ]
}

modify_kbCredential(kbCredentialsId: str, kbCredential: dict)

Update KB credentials

PUT /eholdings/kb-credentials/{kbCredentialsId}

Parameters

kbCredentialsId (str) –
kbCredential (dict) – See Schema below

Raises

OkapiRequestError – Bad Request
OkapiRequestUnauthorized – Authentication is required
OkapiRequestNotFound – Not Found
OkapiRequestUnprocessableEntity – Unprocessable Entity
OkapiRequestFatalError – Server Error

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "KB Credentials PUT Request Schema",
  "description": "KB Credentials PUT Request Schema",
  "javaType": "org.folio.rest.jaxrs.model.KbCredentialsPutRequest",
  "additionalProperties": false,
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "description": "KB Credentials object",
      "$ref": "kbCredentials.json"
    }
  },
  "required": [
    "data"
  ]
}

set_kbCredential(kbCredential: dict)

Create KB credentials

POST /eholdings/kb-credentials

Parameters

kbCredential (dict) – See Schema below

Returns

See Schema below

Return type

dict

Raises

OkapiRequestError – Bad Request
OkapiRequestUnauthorized – Authentication is required
OkapiRequestUnprocessableEntity – Unprocessable Entity
OkapiRequestFatalError – Server Error

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "POST Request To KB Credentials Collection Schema",
  "description": "POST Request To KB Credentials Collection Schema",
  "javaType": "org.folio.rest.jaxrs.model.KbCredentialsPostRequest",
  "additionalProperties": false,
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "description": "KB Credentials object",
      "$ref": "kbCredentials.json"
    }
  },
  "required": [
    "data"
  ]
}

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "KB Credentials Collection Item Schema",
  "description": "KB Credentials Collection Item Schema",
  "javaType": "org.folio.rest.jaxrs.model.KbCredentials",
  "additionalProperties": false,
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "The UUID of entry",
      "$ref": "../../raml-util/schemas/uuid.schema",
      "examples": "2ffa1940-2cf6-48b1-8cc9-5e539c61d93f"
    },
    "type": {
      "type": "string",
      "description": "Type of resource",
      "enum": [
        "kbCredentials"
      ],
      "example": "kbCredentials"
    },
    "attributes": {
      "type": "object",
      "description": "KB credentials collection item attributes",
      "$ref": "kbCredentialsDataAttributes.json"
    },
    "meta": {
      "type": "object",
      "description": "Metadata about creation and changes to item",
      "$ref": "../../raml-util/schemas/metadata.schema",
      "readonly": true
    }
  },
  "required": [
    "type",
    "attributes"
  ]
}