foliolib.folio.api.kbEbscoJava.Proxies

class foliolib.folio.api.kbEbscoJava.Proxies(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

get_proxyTypes()	Get a list of supported proxy types.
get_proxyTypes_by_kbCredential(kbCredentialsId)	Get a list of supported proxy types for KB Credentials.
get_rootProxies()	Get the ID of root proxy that is currently selected from proxy-type list.
get_rootProxy_by_kbCredential(kbCredentialsId)	Get the ID of root proxy that is currently selected from proxy-type list.
modify_rootProxy(kbCredentialsId, rootProxy)	Update root-proxy for a Kb Credentials.

get_proxyTypes()

Get a list of supported proxy types.

GET /eholdings/proxy-types

Returns

See Schema below

Return type

dict

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Proxy Types Schema",
  "description": "Proxy Types Schema",
  "javaType": "org.folio.rest.jaxrs.model.ProxyTypes",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "data": {
      "type": "array",
      "description": "List of proxy types for a given customer",
      "items": {
        "type": "object",
        "$ref": "proxyTypesData.json"
      }
    },
    "meta": {
      "type": "object",
      "description": "metadata containing total results in packages collection",
      "$ref": "../metaTotalResults.json"
    },
    "jsonapi": {
      "type": "object",
      "description": "version of json api",
      "$ref": "../jsonapi.json"
    }
  },
  "required": [
    "data"
  ]
}

get_proxyTypes_by_kbCredential(kbCredentialsId: str)

Get a list of supported proxy types for KB Credentials.

GET /eholdings/kb-credentials/{kbCredentialsId}/proxy-types

Parameters

kbCredentialsId (str) –

Returns

See Schema below

Return type

dict

Raises

OkapiRequestNotFound – Not Found

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Proxy Types Schema",
  "description": "Proxy Types Schema",
  "javaType": "org.folio.rest.jaxrs.model.ProxyTypes",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "data": {
      "type": "array",
      "description": "List of proxy types for a given customer",
      "items": {
        "type": "object",
        "$ref": "proxyTypesData.json"
      }
    },
    "meta": {
      "type": "object",
      "description": "metadata containing total results in packages collection",
      "$ref": "../metaTotalResults.json"
    },
    "jsonapi": {
      "type": "object",
      "description": "version of json api",
      "$ref": "../jsonapi.json"
    }
  },
  "required": [
    "data"
  ]
}

get_rootProxies()

Get the ID of root proxy that is currently selected from proxy-type list.

GET /eholdings/root-proxy

Returns

See Schema below

Return type

dict

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Root Proxy Schema",
  "description": "Root Proxy Schema",
  "javaType": "org.folio.rest.jaxrs.model.RootProxy",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "data": {
      "type": "object",
      "description": "Details of root proxy set for a given customer",
      "$ref": "rootProxyData.json"
    },
    "jsonapi": {
      "type": "object",
      "description": "version of json api",
      "$ref": "../jsonapi.json"
    }
  },
  "required": [
    "data"
  ]
}

get_rootProxy_by_kbCredential(kbCredentialsId: str)

Get the ID of root proxy that is currently selected from proxy-type list.

GET /eholdings/kb-credentials/{kbCredentialsId}/root-proxy

Parameters

kbCredentialsId (str) –

Returns

See Schema below

Return type

dict

Raises

OkapiRequestNotFound – Not Found

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Root Proxy Schema",
  "description": "Root Proxy Schema",
  "javaType": "org.folio.rest.jaxrs.model.RootProxy",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "data": {
      "type": "object",
      "description": "Details of root proxy set for a given customer",
      "$ref": "rootProxyData.json"
    },
    "jsonapi": {
      "type": "object",
      "description": "version of json api",
      "$ref": "../jsonapi.json"
    }
  },
  "required": [
    "data"
  ]
}

modify_rootProxy(kbCredentialsId: str, rootProxy: dict)

Update root-proxy for a Kb Credentials.

PUT /eholdings/kb-credentials/{kbCredentialsId}/root-proxy

Parameters

• kbCredentialsId (str) –

• rootProxy (dict) – See Schema below

Returns

See Schema below

Return type

dict

Raises

OkapiRequestUnprocessableEntity – Unprocessable Entity

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Root Proxy Put Request Schema",
  "description": "Root Proxy Put Request Schema using JSON API",
  "javaType": "org.folio.rest.jaxrs.model.RootProxyPutRequest",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "data": {
      "type": "object",
      "description": "Data object of root proxy put request",
      "$ref": "rootProxyPutData.json"
    }
  },
  "required": [
    "data"
  ]
}

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Root Proxy Schema",
  "description": "Root Proxy Schema",
  "javaType": "org.folio.rest.jaxrs.model.RootProxy",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "data": {
      "type": "object",
      "description": "Details of root proxy set for a given customer",
      "$ref": "rootProxyData.json"
    },
    "jsonapi": {
      "type": "object",
      "description": "version of json api",
      "$ref": "../jsonapi.json"
    }
  },
  "required": [
    "data"
  ]
}