foliolib.folio.api.inventoryStorage.HoldingsType

class foliolib.folio.api.inventoryStorage.HoldingsType(tenant: str)

Bases: foliolib.folio.FolioApi

Holdings types API

This documents the API calls that can be made to query and manage holdings types of the system

Base class of the Folio API

Parameters

tenant (str) – Tenant id

Methods

delete_holdingsType(holdingsTypesId)

Delete holdingsType item with given {holdingsTypeId}

get_holdingsType(holdingsTypesId)

Retrieve holdingsType item with given {holdingsTypeId}

get_holdingsTypes(**kwargs)

Return a list of holdings types

modify_holdingsType(holdingsTypesId, ...)

Update holdingsType item with given {holdingsTypeId}

set_holdingsType(holdingsType)

Create a new holdings type
delete_holdingsType(holdingsTypesId: str)

Delete holdingsType item with given {holdingsTypeId}

DELETE /holdings-types/{holdingsTypesId}

Parameters

holdingsTypesId (str) –

Raises

  • OkapiRequestNotFound – Not Found

  • OkapiRequestError – Bad Request

  • OkapiRequestFatalError – Server Error

get_holdingsType(holdingsTypesId: str)

Retrieve holdingsType item with given {holdingsTypeId}

GET /holdings-types/{holdingsTypesId}

Parameters

holdingsTypesId (str) –

Returns

See Schema below

Return type

dict

Raises

  • OkapiRequestNotFound – Not Found

  • OkapiRequestFatalError – Server Error

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "A holdings type",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "unique ID of the holdings type; a UUID"
    },
    "name": {
      "type": "string",
      "description": "name of the holdings type"
    },
    "source": {
      "type": "string",
      "description": "label indicating where the holdings type entry originates from, i.e. 'folio' or 'local'"
    },
    "metadata": {
      "type": "object",
      "$ref": "../raml-util/schemas/metadata.schema",
      "readonly": true
    }
  },
  "additionalProperties": false,
  "required": [
    "name",
    "source"
  ]
}
get_holdingsTypes(**kwargs)

Return a list of holdings types

GET /holdings-types

Parameters

**kwargs (properties) – Keyword Arguments

Keyword Arguments

  • 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.

    with valid searchable fields

    Example

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

    • name=aaa

  • totalRecords (str) –

    (default=auto) How to calculate the totalRecords property. “exact” for the correct number, “estimated” for an estimation, “auto” to automatically select “exact” or “estimated”, “none” for suppressing the totalRecords property. For details see https://github.com/folio-org/raml-module-builder#estimated-totalrecords

    Example

    • none

  • 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

Returns

See Schema below

Return type

dict

Raises

  • OkapiRequestError – Bad Request

  • OkapiRequestUnauthorized – Authentication is required

  • OkapiRequestFatalError – Server Error

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "A collection of holdings types",
  "type": "object",
  "properties": {
    "holdingsTypes": {
      "description": "List of holdings types",
      "id": "holdingsType",
      "type": "array",
      "items": {
        "type": "object",
        "$ref": "holdingsType.json"
      }
    },
    "totalRecords": {
      "description": "Estimated or exact total number of records",
      "type": "integer"
    }
  },
  "required": [
    "holdingsTypes",
    "totalRecords"
  ]
}
modify_holdingsType(holdingsTypesId: str, holdingsType: dict)

Update holdingsType item with given {holdingsTypeId}

PUT /holdings-types/{holdingsTypesId}

Parameters

  • holdingsTypesId (str) –

  • holdingsType (dict) – See Schema below

Raises

  • OkapiRequestNotFound – Not Found

  • OkapiRequestError – Bad Request

  • OkapiRequestConflict – Conflict

  • OkapiRequestFatalError – Server Error

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "A holdings type",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "unique ID of the holdings type; a UUID"
    },
    "name": {
      "type": "string",
      "description": "name of the holdings type"
    },
    "source": {
      "type": "string",
      "description": "label indicating where the holdings type entry originates from, i.e. 'folio' or 'local'"
    },
    "metadata": {
      "type": "object",
      "$ref": "../raml-util/schemas/metadata.schema",
      "readonly": true
    }
  },
  "additionalProperties": false,
  "required": [
    "name",
    "source"
  ]
}
set_holdingsType(holdingsType: dict)

Create a new holdings type

POST /holdings-types

Parameters

holdingsType (dict) – See Schema below

Raises

  • OkapiRequestError – Bad Request

  • OkapiRequestUnauthorized – Authentication is required

  • OkapiRequestFatalError – Server Error

  • OkapiRequestUnprocessableEntity – Unprocessable Entity

Headers

  • Location - URI to the created holdingsType item

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "A holdings type",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "unique ID of the holdings type; a UUID"
    },
    "name": {
      "type": "string",
      "description": "name of the holdings type"
    },
    "source": {
      "type": "string",
      "description": "label indicating where the holdings type entry originates from, i.e. 'folio' or 'local'"
    },
    "metadata": {
      "type": "object",
      "$ref": "../raml-util/schemas/metadata.schema",
      "readonly": true
    }
  },
  "additionalProperties": false,
  "required": [
    "name",
    "source"
  ]
}