foliolib.folio.api.inventoryStorage.CallNumberType

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

Bases: foliolib.folio.FolioApi

Call number types API

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

Base class of the Folio API

Parameters

tenant (str) – Tenant id

Methods

delete_callNumberType(callNumberTypesId)	Delete callNumberType item with given {callNumberTypeId}
get_callNumberType(callNumberTypesId)	Retrieve callNumberType item with given {callNumberTypeId}
get_callNumberTypes(**kwargs)	Return a list of call number types
modify_callNumberType(callNumberTypesId, ...)	Update callNumberType item with given {callNumberTypeId}
set_callNumberType(callNumberType)	Create a new call number type

delete_callNumberType(callNumberTypesId: str)

Delete callNumberType item with given {callNumberTypeId}

DELETE /call-number-types/{callNumberTypesId}

Parameters

callNumberTypesId (str) –

Raises

• OkapiRequestNotFound – Not Found

• OkapiRequestError – Bad Request

• OkapiRequestFatalError – Server Error

get_callNumberType(callNumberTypesId: str)

Retrieve callNumberType item with given {callNumberTypeId}

GET /call-number-types/{callNumberTypesId}

Parameters

callNumberTypesId (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 call number type",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "unique ID of the call number type; a UUID"
    },
    "name": {
      "type": "string",
      "description": "name of the call number type"
    },
    "source": {
      "type": "string",
      "description": "label indicating where the call number 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_callNumberTypes(**kwargs)

Return a list of call number types

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

modify_callNumberType(callNumberTypesId: str, callNumberType: dict)

Update callNumberType item with given {callNumberTypeId}

PUT /call-number-types/{callNumberTypesId}

Parameters

• callNumberTypesId (str) –

• callNumberType (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 call number type",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "unique ID of the call number type; a UUID"
    },
    "name": {
      "type": "string",
      "description": "name of the call number type"
    },
    "source": {
      "type": "string",
      "description": "label indicating where the call number 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_callNumberType(callNumberType: dict)

Create a new call number type

POST /call-number-types

Parameters

callNumberType (dict) – See Schema below

Raises

• OkapiRequestError – Bad Request

• OkapiRequestUnauthorized – Authentication is required

• OkapiRequestFatalError – Server Error

• OkapiRequestUnprocessableEntity – Unprocessable Entity

Headers

• Location - URI to the created callNumberType item

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "A call number type",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "unique ID of the call number type; a UUID"
    },
    "name": {
      "type": "string",
      "description": "name of the call number type"
    },
    "source": {
      "type": "string",
      "description": "label indicating where the call number 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"
  ]
}