foliolib.folio.api.kbEbscoJava.Costperuse

class foliolib.folio.api.kbEbscoJava.Costperuse(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_costperuse_by_package(packageId, **kwargs)

Retrieve cost-per-use information for package resources

get_costperuse_by_package_by_packageId(...)

Retrieve cost-per-use information for a particular package

get_costperuse_by_resource(resourceId, **kwargs)

Retrieve cost-per-use information for a particular resource

get_costperuse_by_title(titleId, **kwargs)

Retrieve cost-per-use information for a particular title
get_costperuse_by_package(packageId: str, **kwargs)

Retrieve cost-per-use information for package resources

GET /eholdings/packages/{packageId}/resources/costperuse

Parameters

  • packageId (str) –

  • **kwargs (properties) – Keyword Arguments

Keyword Arguments

  • platform (str) –

    Include publisher, non-publisher or all platforms Possible values are

    • publisher

    • nonPublisher

    • all

  • fiscalYear (str) – Fiscal year of cost-per-use data

  • order (order) – (default=asc) Order

  • sort (str) – (default=name) Option by which results are sorted. Possible values are name, type, cost, usage, costperuse, percent.

  • page (int) –

    (default=1) Page number

    Example

    • 1

  • count (int) –

    (default=<<defaultCountValue>>) Page size

    Example

    • 100

Returns

See Schema below

Return type

dict

Raises

  • OkapiRequestError – Bad Request

  • OkapiRequestUnprocessableEntity – Unprocessable Entity

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Resources' cost-per-use collection object schema",
  "description": "Resources' cost-per-use collection object schema",
  "type": "object",
  "javaType": "org.folio.rest.jaxrs.model.ResourceCostPerUseCollection",
  "additionalProperties": false,
  "properties": {
    "data": {
      "type": "array",
      "description": "List of resources' cost-per-use",
      "items": {
        "type": "object",
        "$ref": "resourceCostPerUseCollectionItem.json"
      }
    },
    "parameters": {
      "type": "object",
      "description": "Response's parameters",
      "$ref": "costPerUseParameters.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"
  ]
}
get_costperuse_by_package_by_packageId(packageId: str, **kwargs)

Retrieve cost-per-use information for a particular package

GET /eholdings/packages/{packageId}/costperuse

Parameters

  • packageId (str) –

  • **kwargs (properties) – Keyword Arguments

Keyword Arguments

  • platform (str) –

    Include publisher, non-publisher or all platforms Possible values are

    • publisher

    • nonPublisher

    • all

  • fiscalYear (str) – Fiscal year of cost-per-use data

Returns

See Schema below

Return type

dict

Raises

  • OkapiRequestError – Bad Request

  • OkapiRequestUnprocessableEntity – Unprocessable Entity

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Package cost-per-use object schema",
  "description": "Package cost-per-use object schema",
  "type": "object",
  "javaType": "org.folio.rest.jaxrs.model.PackageCostPerUse",
  "additionalProperties": false,
  "properties": {
    "packageId": {
      "type": "string",
      "description": "Package ID",
      "example": "15-1440285"
    },
    "type": {
      "type": "string",
      "description": "Type of resource",
      "enum": [
        "packageCostPerUse"
      ],
      "example": "packageCostPerUse"
    },
    "attributes": {
      "type": "object",
      "description": "Package cost-per-use attributes",
      "$ref": "packageCostPerUseDataAttributes.json"
    }
  },
  "required": [
    "type",
    "attributes"
  ]
}
get_costperuse_by_resource(resourceId: str, **kwargs)

Retrieve cost-per-use information for a particular resource

GET /eholdings/resources/{resourceId}/costperuse

Parameters

  • resourceId (str) –

  • **kwargs (properties) – Keyword Arguments

Keyword Arguments

  • platform (str) –

    Include publisher, non-publisher or all platforms Possible values are

    • publisher

    • nonPublisher

    • all

  • fiscalYear (str) – Fiscal year of cost-per-use data

Returns

See Schema below

Return type

dict

Raises

  • OkapiRequestError – Bad Request

  • OkapiRequestUnprocessableEntity – Unprocessable Entity

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Resource cost-per-use object schema",
  "description": "Resource cost-per-use object schema",
  "type": "object",
  "javaType": "org.folio.rest.jaxrs.model.ResourceCostPerUse",
  "additionalProperties": false,
  "properties": {
    "resourceId": {
      "type": "string",
      "description": "Resource ID",
      "example": "22-1887786-1440285"
    },
    "type": {
      "type": "string",
      "description": "Type of resource",
      "enum": [
        "resourceCostPerUse"
      ],
      "example": "resourceCostPerUse"
    },
    "attributes": {
      "type": "object",
      "description": "Resource cost-per-use attributes",
      "$ref": "resourceCostPerUseDataAttributes.json"
    }
  },
  "required": [
    "type",
    "attributes"
  ]
}
get_costperuse_by_title(titleId: str, **kwargs)

Retrieve cost-per-use information for a particular title

GET /eholdings/titles/{titleId}/costperuse

Parameters

  • titleId (str) –

  • **kwargs (properties) – Keyword Arguments

Keyword Arguments

  • platform (str) –

    Include publisher, non-publisher or all platforms Possible values are

    • publisher

    • nonPublisher

    • all

  • fiscalYear (str) – Fiscal year of cost-per-use data

Returns

See Schema below

Return type

dict

Raises

  • OkapiRequestError – Bad Request

  • OkapiRequestUnprocessableEntity – Unprocessable Entity

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Title cost-per-use object schema",
  "description": "Title cost-per-use object schema",
  "type": "object",
  "javaType": "org.folio.rest.jaxrs.model.TitleCostPerUse",
  "additionalProperties": false,
  "properties": {
    "titleId": {
      "type": "string",
      "description": "Title ID",
      "example": "1440285"
    },
    "type": {
      "type": "string",
      "description": "Type of resource",
      "enum": [
        "titleCostPerUse"
      ],
      "example": "titleCostPerUse"
    },
    "attributes": {
      "type": "object",
      "description": "Title cost-per-use attributes",
      "$ref": "titleCostPerUseDataAttributes.json"
    }
  },
  "required": [
    "type",
    "attributes"
  ]
}