foliolib.folio.api.kbEbscoJava.Tags

class foliolib.folio.api.kbEbscoJava.Tags(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_summaries`(**kwargs)	Retrieve a collection of unique tags associated with eholding records.
`get_tags`(**kwargs)	Retrieve a collection of tags associated with eholding records.

get_summaries(**kwargs)

Retrieve a collection of unique tags associated with eholding records.

GET /eholdings/tags/summary

Parameters

**kwargs (properties) – Keyword Arguments

Keyword Arguments

filter[rectype] (recordType[]) –

Filter tags by one or more record types. Several types can be specified in form of filter[rectype]=provider&filter[rectype]=package Possible values are provider, package, title, resource

Example

[‘provider’, ‘package’]

Returns

See Schema below

Return type

dict

Raises

OkapiRequestError – Bad Request

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Tag Collection Schema of Unique Items",
  "description": "Tag Collection Schema of Unique Items",
  "javaType": "org.folio.rest.jaxrs.model.TagUniqueCollection",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "data": {
      "type": "array",
      "description": "List of unique tags",
      "items": {
        "type": "object",
        "$ref": "tagUniqueCollectionItem.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",
    "jsonapi"
  ]
}

get_tags(**kwargs)

Retrieve a collection of tags associated with eholding records.

GET /eholdings/tags

Parameters

**kwargs (properties) – Keyword Arguments

Keyword Arguments

filter[rectype] (recordType[]) –

Filter tags by one or more record types. Several types can be specified in form of filter[rectype]=provider&filter[rectype]=package Possible values are provider, package, title, resource

Example

[‘provider’, ‘package’]

Returns

See Schema below

Return type

dict

Raises

OkapiRequestError – Bad Request

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Tag Collection Schema",
  "description": "Tag Collection Schema",
  "javaType": "org.folio.rest.jaxrs.model.TagCollection",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "data": {
      "type": "array",
      "description": "List of tags",
      "items": {
        "type": "object",
        "$ref": "tagCollectionItem.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",
    "jsonapi"
  ]
}