foliolib.folio.api.inventoryStorage.StatisticalCodeType

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

Bases: foliolib.folio.FolioApi

Statistical code type reference API

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

Parameters

• tenant (str) – Tenant id

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

Methods

delete_statisticalCodeType(statisticalCodeTypeId)	Delete statisticalCodeType item with given {statisticalCodeTypeId}
delete_statisticalCodeTypes()	DELETE /statistical-code-types
get_statisticalCodeType(statisticalCodeTypeId)	Retrieve statisticalCodeType item with given {statisticalCodeTypeId}
get_statisticalCodeTypes(**kwargs)	Return a list of statistical code types
modify_statisticalCodeType(...)	Update statisticalCodeType item with given {statisticalCodeTypeId}
set_statisticalCodeType(statisticalCodeType)	Create a new statistical code type

delete_statisticalCodeType(statisticalCodeTypeId: str)

Delete statisticalCodeType item with given {statisticalCodeTypeId}

DELETE /statistical-code-types/{statisticalCodeTypeId}

Parameters

statisticalCodeTypeId (str) –

Raises

• OkapiRequestNotFound – Not Found

• OkapiRequestError – Bad Request

• OkapiFatalError – Server Error

delete_statisticalCodeTypes()

DELETE /statistical-code-types

get_statisticalCodeType(statisticalCodeTypeId: str)

Retrieve statisticalCodeType item with given {statisticalCodeTypeId}

GET /statistical-code-types/{statisticalCodeTypeId}

Parameters

statisticalCodeTypeId (str) –

Returns

See Schema below

Return type

dict

Raises

• OkapiRequestNotFound – Not Found

• OkapiFatalError – Server Error

Schema

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

get_statisticalCodeTypes(**kwargs)

Return a list of statistical code types

GET /statistical-code-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

• 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

• OkapiFatalError – Server Error

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "A collection of statistical code types",
  "type": "object",
  "properties": {
    "statisticalCodeTypes": {
      "description": "List of statistical code types",
      "id": "statisticalCodeType",
      "type": "array",
      "items": {
        "type": "object",
        "$ref": "statisticalcodetype.json"
      }
    },
    "totalRecords": {
      "description": "Estimated or exact total number of records",
      "type": "integer"
    }
  },
  "required": [
    "statisticalCodeTypes",
    "totalRecords"
  ]
}

modify_statisticalCodeType(statisticalCodeTypeId: str, statisticalCodeType: dict)

Update statisticalCodeType item with given {statisticalCodeTypeId}

PUT /statistical-code-types/{statisticalCodeTypeId}

Parameters

• statisticalCodeTypeId (str) –

• statisticalCodeType (dict) – See Schema below

Raises

• OkapiRequestNotFound – Not Found

• OkapiRequestError – Bad Request

• OkapiRequestConflict – Conflict

• OkapiFatalError – Server Error

Schema

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

set_statisticalCodeType(statisticalCodeType: dict)

Create a new statistical code type

POST /statistical-code-types

Parameters

statisticalCodeType (dict) – See Schema below

Raises

• OkapiRequestError – Bad Request

• OkapiRequestUnauthorized – Authentication is required

• OkapiFatalError – Server Error

• OkapiRequestUnprocessableEntity – Unprocessable Entity

Headers

• Location - URI to the created statisticalCodeType item

Schema

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