foliolib.folio.api.oaiPmh.FolioSetFilteringConditions

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

Bases: foliolib.folio.FolioApi

Set API

API for retirieving filtering condition values

Parameters
  • tenant (str) – Tenant id

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

Methods

get_filteringConditions()

GET /oai-pmh/filtering-conditions

get_filteringConditions()

GET /oai-pmh/filtering-conditions

Returns

See Schema below

Return type

dict

Raises
  • OkapiRequestUnauthorized – Authentication is required

  • OkapiFatalError – Server Error

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "Filtering condition DTO Schema",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "setsFilteringConditions": {
      "description": "list of filtering condition values",
      "type": "array",
      "id": "filteringConditionValues",
      "items": {
        "type": "object",
        "$ref": "filteringConditionValue.json"
      }
    }
  }
}