foliolib.folio.api.inventoryStorage.MaterialType

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

Bases: foliolib.folio.FolioApi

Material Types API

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

Base class of the Folio API

Parameters

tenant (str) – Tenant id

Methods

delete_materialType(materialtypeId)	Delete materialType item with given {materialTypeId}
delete_materialTypes()	DELETE /material-types
get_materialType(materialtypeId)	Retrieve materialType item with given {materialTypeId}
get_materialTypes(**kwargs)	Return a list of material types
modify_materialType(materialtypeId, materialType)	Update materialType item with given {materialTypeId}
set_materialType(materialType)	Create a new material type

delete_materialType(materialtypeId: str)

Delete materialType item with given {materialTypeId}

DELETE /material-types/{materialtypeId}

Parameters

materialtypeId (str) –

Raises

• OkapiRequestNotFound – Not Found

• OkapiRequestError – Bad Request

• OkapiRequestFatalError – Server Error

delete_materialTypes()

DELETE /material-types

get_materialType(materialtypeId: str)

Retrieve materialType item with given {materialTypeId}

GET /material-types/{materialtypeId}

Parameters

materialtypeId (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 material type",
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "name": {
      "description": "label for the material type",
      "type": "string"
    },
    "source": {
      "description": "origin of the material type record",
      "type": "string"
    },
    "metadata": {
      "type": "object",
      "$ref": "raml-util/schemas/metadata.schema",
      "readonly": true
    }
  },
  "additionalProperties": false,
  "required": [
    "name"
  ]
}

get_materialTypes(**kwargs)

Return a list of material types

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

modify_materialType(materialtypeId: str, materialType: dict)

Update materialType item with given {materialTypeId}

PUT /material-types/{materialtypeId}

Parameters

• materialtypeId (str) –

• materialType (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 material type",
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "name": {
      "description": "label for the material type",
      "type": "string"
    },
    "source": {
      "description": "origin of the material type record",
      "type": "string"
    },
    "metadata": {
      "type": "object",
      "$ref": "raml-util/schemas/metadata.schema",
      "readonly": true
    }
  },
  "additionalProperties": false,
  "required": [
    "name"
  ]
}

set_materialType(materialType: dict)

Create a new material type

POST /material-types

Parameters

materialType (dict) – See Schema below

Raises

• OkapiRequestError – Bad Request

• OkapiRequestUnauthorized – Authentication is required

• OkapiRequestFatalError – Server Error

• OkapiRequestUnprocessableEntity – Unprocessable Entity

Headers

• Location - URI to the created materialType item

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "A material type",
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "name": {
      "description": "label for the material type",
      "type": "string"
    },
    "source": {
      "description": "origin of the material type record",
      "type": "string"
    },
    "metadata": {
      "type": "object",
      "$ref": "raml-util/schemas/metadata.schema",
      "readonly": true
    }
  },
  "additionalProperties": false,
  "required": [
    "name"
  ]
}