foliolib.folio.api.inventoryStorage.HoldingsNoteType

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

Bases: foliolib.folio.FolioApi

Holdings note types API

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

Base class of the Folio API

Parameters

tenant (str) – Tenant id

Methods

delete_holdingsNoteType(holdingsNoteTypesId)	Delete holdingsNoteType item with given {holdingsNoteTypeId}
get_holdingsNoteType(holdingsNoteTypesId)	Retrieve holdingsNoteType item with given {holdingsNoteTypeId}
get_holdingsNoteTypes(**kwargs)	Return a list of holdings note types
modify_holdingsNoteType(holdingsNoteTypesId, ...)	Update holdingsNoteType item with given {holdingsNoteTypeId}
set_holdingsNoteType(holdingsNoteType)	Create a new holdings note type

delete_holdingsNoteType(holdingsNoteTypesId: str)

Delete holdingsNoteType item with given {holdingsNoteTypeId}

DELETE /holdings-note-types/{holdingsNoteTypesId}

Parameters

holdingsNoteTypesId (str) –

Raises

• OkapiRequestNotFound – Not Found

• OkapiRequestError – Bad Request

• OkapiRequestFatalError – Server Error

get_holdingsNoteType(holdingsNoteTypesId: str)

Retrieve holdingsNoteType item with given {holdingsNoteTypeId}

GET /holdings-note-types/{holdingsNoteTypesId}

Parameters

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

Return a list of holdings note types

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

modify_holdingsNoteType(holdingsNoteTypesId: str, holdingsNoteType: dict)

Update holdingsNoteType item with given {holdingsNoteTypeId}

PUT /holdings-note-types/{holdingsNoteTypesId}

Parameters

• holdingsNoteTypesId (str) –

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

Create a new holdings note type

POST /holdings-note-types

Parameters

holdingsNoteType (dict) – See Schema below

Raises

• OkapiRequestError – Bad Request

• OkapiRequestUnauthorized – Authentication is required

• OkapiRequestFatalError – Server Error

• OkapiRequestUnprocessableEntity – Unprocessable Entity

Headers

• Location - URI to the created holdingsNoteType item

Schema

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