foliolib.folio.api.kbEbscoJava.Eholdings

class foliolib.folio.api.kbEbscoJava.Eholdings(tenant: str, okapi: Optional[foliolib.okapi.okapiClient.OkapiClient] = None)

Bases: foliolib.folio.FolioApi

mod-kb-ebsco-java

Implements the eholdings interface using EBSCO KB as backend.

Parameters

  • tenant (str) – Tenant id

  • okapi (OkapiClient, optional) – Instance of OkapiClient. Defaults to None.

Methods

delete_caches()

Invalidate configuration cache for tenant

get_status_by_kbCredential(kbCredentialsId)

Get current status of load holdings job.

get_statuses()

Gives status of currently set KB configuration.

set_kbCredential()

Run load holdings job.

set_kbCredential_by_kbCredentialsId(...)

Run load holdings job by credentials id.
delete_caches()

Invalidate configuration cache for tenant

DELETE /eholdings/cache

get_status_by_kbCredential(kbCredentialsId: str)

Get current status of load holdings job.

GET /eholdings/loading/kb-credentials/{kbCredentialsId}/status

Parameters

kbCredentialsId (str) –

Returns

See Schema below

Return type

dict

Raises

  • OkapiRequestNotFound – Not Found

  • OkapiFatalError – Server Error

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Holdings Loading Status Schema",
  "description": "Holdings Loading Status Schema",
  "javaType": "org.folio.rest.jaxrs.model.HoldingsLoadingStatus",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "data": {
      "type": "object",
      "description": "Status data",
      "$ref": "loadHoldingsStatusData.json"
    },
    "jsonapi": {
      "type": "object",
      "description": "version of json api",
      "$ref": "../jsonapi.json"
    }
  },
  "required": [
    "data",
    "jsonapi"
  ]
}
get_statuses()

Gives status of currently set KB configuration.

GET /eholdings/status

Returns

See Schema below

Return type

dict

Raises

OkapiFatalError – Server Error

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Status Response Schema",
  "description": "Status Response Schema using JSON API",
  "type": "object",
  "javaType": "org.folio.rest.jaxrs.model.ConfigurationStatus",
  "additionalProperties": false,
  "properties": {
    "data": {
      "type": "object",
      "javaType": "org.folio.rest.jaxrs.model.StatusData",
      "description": "Status Data",
      "$ref": "statusData.json"
    },
    "jsonapi": {
      "type": "object",
      "description": "JSON API Version",
      "$ref": "../jsonapi.json"
    }
  }
}
set_kbCredential()

Run load holdings job.

POST /eholdings/loading/kb-credentials

Raises

  • OkapiRequestConflict – Conflict

  • OkapiFatalError – Server Error

set_kbCredential_by_kbCredentialsId(kbCredentialsId: str)

Run load holdings job by credentials id.

POST /eholdings/loading/kb-credentials/{kbCredentialsId}

Parameters

kbCredentialsId (str) –

Raises

  • OkapiRequestNotFound – Not Found

  • OkapiRequestConflict – Conflict

  • OkapiFatalError – Server Error