foliolib.folio.api.inventoryStorage.ClassificationType

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

Bases: foliolib.folio.FolioApi

Classification Types API

This documents the API calls that can be made to query and manage classification qualifier resource types

Base class of the Folio API

Parameters

tenant (str) – Tenant id

Methods

delete_classificationType(classificationTypeId)	Delete classificationType item with given {classificationTypeId}
get_classificationType(classificationTypeId)	Retrieve classificationType item with given {classificationTypeId}
get_classificationTypes(**kwargs)	Return a list of classification qualifiers
modify_classificationType(...)	Update classificationType item with given {classificationTypeId}
set_classificationType(classificationType)	Create a new classification type

delete_classificationType(classificationTypeId: str)

Delete classificationType item with given {classificationTypeId}

DELETE /classification-types/{classificationTypeId}

Parameters

classificationTypeId (str) –

Raises

• OkapiRequestNotFound – Not Found

• OkapiRequestError – Bad Request

• OkapiRequestFatalError – Server Error

get_classificationType(classificationTypeId: str)

Retrieve classificationType item with given {classificationTypeId}

GET /classification-types/{classificationTypeId}

Parameters

classificationTypeId (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 classification type",
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "name": {
      "description": "label for the classification type",
      "type": "string"
    },
    "source": {
      "type": "string",
      "description": "label indicating where the classification type entry originates from, i.e. 'folio' or 'local'"
    },
    "metadata": {
      "type": "object",
      "$ref": "raml-util/schemas/metadata.schema",
      "readonly": true
    }
  },
  "required": [
    "name"
  ]
}

get_classificationTypes(**kwargs)

Return a list of classification qualifiers

GET /classification-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 classification types",
  "type": "object",
  "properties": {
    "classificationTypes": {
      "description": "List of classification types",
      "id": "classificationType",
      "type": "array",
      "items": {
        "type": "object",
        "$ref": "classificationtype.json"
      }
    },
    "totalRecords": {
      "description": "Estimated or exact total number of records",
      "type": "integer"
    }
  },
  "required": [
    "classificationTypes",
    "totalRecords"
  ]
}

modify_classificationType(classificationTypeId: str, classificationType: dict)

Update classificationType item with given {classificationTypeId}

PUT /classification-types/{classificationTypeId}

Parameters

• classificationTypeId (str) –

• classificationType (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 classification type",
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "name": {
      "description": "label for the classification type",
      "type": "string"
    },
    "source": {
      "type": "string",
      "description": "label indicating where the classification type entry originates from, i.e. 'folio' or 'local'"
    },
    "metadata": {
      "type": "object",
      "$ref": "raml-util/schemas/metadata.schema",
      "readonly": true
    }
  },
  "required": [
    "name"
  ]
}

set_classificationType(classificationType: dict)

Create a new classification type

POST /classification-types

Parameters

classificationType (dict) – See Schema below

Raises

• OkapiRequestError – Bad Request

• OkapiRequestUnauthorized – Authentication is required

• OkapiRequestFatalError – Server Error

• OkapiRequestUnprocessableEntity – Unprocessable Entity

Headers

• Location - URI to the created classificationType item

Schema

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