foliolib.folio.api.orders.HoldingSummary

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

Bases: foliolib.folio.FolioApi

Holding summaries

CRUD API to manage Holding summaries.

Parameters

• tenant (str) – Tenant id

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

Methods

get_holdingSummaries(holdingSummaryId)

Retrieve a list of holdingSummary items.

get_holdingSummaries(holdingSummaryId: str)

Retrieve a list of holdingSummary items.

GET /orders/holding-summary/{holdingSummaryId}

Parameters

holdingSummaryId (str) –

Returns

See Schema below

Return type

dict

Raises

• OkapiRequestError – Bad Request

• OkapiFatalError – Server Error

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "Collection of holding summary elements",
  "type": "object",
  "properties": {
    "holdingSummaries": {
      "description": "an array of holding summaries",
      "id": "holdingSummaries",
      "type": "array",
      "items": {
        "type": "object",
        "$ref": "holding_summary.json"
      }
    },
    "totalRecords": {
      "description": "total number of records in the array",
      "type": "integer"
    }
  },
  "required": [
    "holdingSummaries",
    "totalRecords"
  ]
}