foliolib.folio.api.kbEbscoJava.Currencies

class foliolib.folio.api.kbEbscoJava.Currencies(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_currencies()

Retrieve a collection of currencies.

get_currencies()

Retrieve a collection of currencies.

GET /eholdings/currencies

Returns: See Schema below
Return type: dict

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Currencies Collection Schema",
  "description": "Currencies Collection Schema",
  "javaType": "org.folio.rest.jaxrs.model.CurrencyCollection",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "data": {
      "type": "array",
      "description": "List of currencies",
      "items": {
        "type": "object",
        "$ref": "currency.json"
      }
    },
    "meta": {
      "type": "object",
      "description": "metadata containing total results in collection",
      "$ref": "../metaTotalResults.json",
      "readonly": true
    },
    "jsonapi": {
      "type": "object",
      "description": "version of json api",
      "$ref": "../jsonapi.json"
    }
  },
  "required": [
    "data",
    "meta",
    "jsonapi"
  ]
}