foliolib.folio.api.circulation.RequestsReports

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

Bases: foliolib.folio.FolioApi

Circulation Business Logic API

API for report generation

Parameters

• tenant (str) – Tenant id

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

Methods

get_holdShelfClearances(servicePointId)

Retrieve holdShelfClearance item with given {holdShelfClearanceId}

get_holdShelfClearances(servicePointId: str)

Retrieve holdShelfClearance item with given {holdShelfClearanceId}

GET /circulation/requests-reports/hold-shelf-clearance/{servicePointId}

Parameters

servicePointId (str) –

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#",
  "title": "Collection of item requests",
  "description": "Collection of item requests",
  "type": "object",
  "properties": {
    "requests": {
      "description": "Paged collection of item requests",
      "id": "requests",
      "type": "array",
      "items": {
        "type": "object",
        "$ref": "request.json"
      }
    },
    "totalRecords": {
      "description": "Total number of item requests",
      "type": "integer"
    }
  },
  "required": [
    "requests",
    "totalRecords"
  ]
}