foliolib.folio.api.circulationStorage.CirculationRulesStorage

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

Bases: foliolib.folio.FolioApi

Circulation Rules Storage API

Storage for circulation rules

Parameters

• tenant (str) – Tenant id

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

Methods

get_circulationRulesStorages()	Get the circulation rules
modify_circulationRulesStorage(...)	Set the circulation rules

get_circulationRulesStorages()

Get the circulation rules

GET /circulation-rules-storage

Returns

See Schema below

Return type

dict

Raises

OkapiFatalError – Server Error

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Circulation Rules Schema",
  "description": "Circulation rules, described in a bespoke syntax",
  "type": "object",
  "properties": {
    "id": {
      "description": "ID of the circulation rules (should only ever be a single record)",
      "type": "string"
    },
    "rulesAsText": {
      "description": "Circulation rules represented in text using the bespoke format",
      "type": "string"
    },
    "metadata": {
      "description": "Metadata about creation and changes to loan, provided by the server (client should not provide)",
      "type": "object",
      "$ref": "raml-util/schemas/metadata.schema"
    }
  },
  "additionalProperties": false,
  "required": [
    "rulesAsText"
  ]
}

modify_circulationRulesStorage(circulationRulesStorage: dict)

Set the circulation rules

PUT /circulation-rules-storage

Parameters

circulationRulesStorage (dict) – See Schema below

Raises

OkapiFatalError – Server Error

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Circulation Rules Schema",
  "description": "Circulation rules, described in a bespoke syntax",
  "type": "object",
  "properties": {
    "id": {
      "description": "ID of the circulation rules (should only ever be a single record)",
      "type": "string"
    },
    "rulesAsText": {
      "description": "Circulation rules represented in text using the bespoke format",
      "type": "string"
    },
    "metadata": {
      "description": "Metadata about creation and changes to loan, provided by the server (client should not provide)",
      "type": "object",
      "$ref": "raml-util/schemas/metadata.schema"
    }
  },
  "additionalProperties": false,
  "required": [
    "rulesAsText"
  ]
}