foliolib.folio.api.circulationStorage.RequestStorageBatch

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

Bases: foliolib.folio.FolioApi

Batch Request Storage API

Batch request operations

Parameters

• tenant (str) – Tenant id

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

Methods

set_request(request)

POST /request-storage-batch/requests

set_request(request: dict)

POST /request-storage-batch/requests

Parameters

request (dict) – See Schema below

Raises

• OkapiFatalError – Server Error

• OkapiRequestUnprocessableEntity – Unprocessable Entity

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "Collection of requests",
  "type": "object",
  "properties": {
    "requests": {
      "description": "List of request items to update",
      "id": "requests",
      "type": "array",
      "items": {
        "type": "object",
        "$ref": "request.json"
      }
    }
  },
  "additionalProperties": false,
  "required": [
    "requests"
  ]
}