foliolib.folio.api.inventoryStorage.InstanceNoteType

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

Bases: foliolib.folio.FolioApi

Instance note types API

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

Base class of the Folio API

Parameters

tenant (str) – Tenant id

Methods

delete_instanceNoteType(instanceNoteTypesId)	Delete instanceNoteType item with given {instanceNoteTypeId}
get_instanceNoteType(instanceNoteTypesId)	Retrieve instanceNoteType item with given {instanceNoteTypeId}
get_instanceNoteTypes(**kwargs)	Return a list of instance note types
modify_instanceNoteType(instanceNoteTypesId, ...)	Update instanceNoteType item with given {instanceNoteTypeId}
set_instanceNoteType(instanceNoteType)	Create a new instance note type

delete_instanceNoteType(instanceNoteTypesId: str)

Delete instanceNoteType item with given {instanceNoteTypeId}

DELETE /instance-note-types/{instanceNoteTypesId}

Parameters

instanceNoteTypesId (str) –

Raises

• OkapiRequestNotFound – Not Found

• OkapiRequestError – Bad Request

• OkapiRequestFatalError – Server Error

get_instanceNoteType(instanceNoteTypesId: str)

Retrieve instanceNoteType item with given {instanceNoteTypeId}

GET /instance-note-types/{instanceNoteTypesId}

Parameters

instanceNoteTypesId (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": "An Instance note type",
  "type": "object",
  "properties": {
    "id": {
      "description": "unique ID of the Instance note type; a UUID",
      "$ref": "uuid.json"
    },
    "name": {
      "type": "string",
      "description": "name of the Instance note type"
    },
    "source": {
      "type": "string",
      "description": "label indicating where the Instance 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_instanceNoteTypes(**kwargs)

Return a list of instance note types

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

modify_instanceNoteType(instanceNoteTypesId: str, instanceNoteType: dict)

Update instanceNoteType item with given {instanceNoteTypeId}

PUT /instance-note-types/{instanceNoteTypesId}

Parameters

• instanceNoteTypesId (str) –

• instanceNoteType (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": "An Instance note type",
  "type": "object",
  "properties": {
    "id": {
      "description": "unique ID of the Instance note type; a UUID",
      "$ref": "uuid.json"
    },
    "name": {
      "type": "string",
      "description": "name of the Instance note type"
    },
    "source": {
      "type": "string",
      "description": "label indicating where the Instance 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_instanceNoteType(instanceNoteType: dict)

Create a new instance note type

POST /instance-note-types

Parameters

instanceNoteType (dict) – See Schema below

Raises

• OkapiRequestError – Bad Request

• OkapiRequestUnauthorized – Authentication is required

• OkapiRequestFatalError – Server Error

• OkapiRequestUnprocessableEntity – Unprocessable Entity

Headers

• Location - URI to the created instanceNoteType item

Schema

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