foliolib.folio.api.patronBlocks.PatronBlockConditions

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

Bases: foliolib.folio.FolioApi

mod-users Patron Block Conditions API

Query and manage each condition that can trigger a patron block and the messages that should be displayed when triggered.

Parameters

• tenant (str) – Tenant id

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

Methods

get_patronBlockCondition(patronBlockConditionId)	Retrieve patronBlockCondition item with given {patronBlockConditionId}
get_patronBlockConditions(**kwargs)	Return a list of patron block conditions
modify_patronBlockCondition(...)	PUT /patron-block-conditions/{patronBlockConditionId}

get_patronBlockCondition(patronBlockConditionId: str)

Retrieve patronBlockCondition item with given {patronBlockConditionId}

GET /patron-block-conditions/{patronBlockConditionId}

Parameters

patronBlockConditionId (str) –

Returns

See Schema below

Return type

dict

Raises

• OkapiRequestUnauthorized – Authentication is required

• OkapiRequestNotFound – Not Found

• OkapiFatalError – Server Error

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "description": "Patron block conditions schema",
  "properties": {
    "id": {
      "type": "string",
      "description": "A UUID identifying the condition",
      "$ref": "raml-util/schemas/uuid.schema"
    },
    "name": {
      "type": "string",
      "description": "The name of the condition"
    },
    "blockBorrowing": {
      "type": "boolean",
      "description": "This flag indicates the block for borrowings"
    },
    "blockRenewals": {
      "type": "boolean",
      "description": "This flag indicates the block for renewals"
    },
    "blockRequests": {
      "type": "boolean",
      "description": "This flag indicates the block for requests"
    },
    "valueType": {
      "type": "string",
      "description": "Defines limit type",
      "enum": [
        "Integer",
        "Double"
      ]
    },
    "message": {
      "type": "string",
      "description": "A message to be displayed"
    },
    "metadata": {
      "type": "object",
      "description": "Metadata about creation and changes to patron block conditions, provided by the server (client should not provide)",
      "$ref": "raml-util/schemas/metadata.schema"
    }
  },
  "required": [
    "id",
    "name",
    "blockBorrowing",
    "blockRenewals",
    "blockRequests",
    "valueType"
  ]
}

get_patronBlockConditions(**kwargs)

Return a list of patron block conditions

GET /patron-block-conditions

Parameters

**kwargs (properties) – Keyword Arguments

Keyword Arguments

• offset (int) –

  (default=0) Skip over a number of elements by specifying an offset value for the query

  Example

  • 0

• limit (int) –

  (default=10) Limit the number of elements returned in the response

  Example

  • 10

• query (str) –

  A query expressed as a CQL string (see [dev.folio.org/reference/glossary#cql](https://dev.folio.org/reference/glossary#cql)) using valid searchable fields. The first example below shows the general form of a full CQL query, but those fields might not be relevant in this context.

  searchable using CQL

  Example

  • (username==”ab*” or personal.firstName==”ab*” or personal.lastName==”ab*”) and active==”true” sortby personal.lastName personal.firstName barcode

  • name=”undergrad*”

Returns

See Schema below

Return type

dict

Raises

• OkapiRequestError – Bad Request

• OkapiRequestUnauthorized – Authentication is required

• OkapiRequestNotFound – Not Found

• OkapiFatalError – Server Error

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "Collection of available conditions",
  "type": "object",
  "properties": {
    "patronBlockConditions": {
      "description": "List of of available patron block conditions",
      "id": "patronBlockConditions",
      "type": "array",
      "items": {
        "type": "object",
        "$ref": "patron-block-condition.json"
      }
    },
    "totalRecords": {
      "type": "integer"
    }
  },
  "additionalProperties": false,
  "required": [
    "patronBlockConditions",
    "totalRecords"
  ]
}

modify_patronBlockCondition(patronBlockConditionId: str)

PUT /patron-block-conditions/{patronBlockConditionId}

Parameters

patronBlockConditionId (str) –