foliolib.folio.api.inventoryStorage.HridSettingsStorage

class foliolib.folio.api.inventoryStorage.HridSettingsStorage(tenant: str)

Bases: foliolib.folio.FolioApi

HRID Settings Storage API

Storage for Human Readable Identifier (HRID) Settings

Base class of the Folio API

Parameters: tenant (str) – Tenant id

Methods

`get_hridSettings`()	Return the HRID settings
`modify_hridSetting`(hridSetting)	Modifies HRID settings

get_hridSettings()

Return the HRID settings

GET /hrid-settings-storage/hrid-settings

Returns

See Schema below

Return type

dict

Raises

OkapiRequestUnauthorized – Authentication is required
OkapiRequestForbidden – Forbidden
OkapiRequestFatalError – Server Error

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "The HRID settings",
  "type": "object",
  "javaType": "org.folio.rest.jaxrs.model.HridSettings",
  "properties": {
    "id": {
      "description": "The ID of the one and only HRID settings record",
      "type": "string",
      "readonly": true,
      "$ref": "uuid.json"
    },
    "instances": {
      "description": "The HRID settings for instances",
      "type": "object",
      "$ref": "hridsetting.json"
    },
    "holdings": {
      "description": "The HRID settings for holdings",
      "type": "object",
      "$ref": "hridsetting.json"
    },
    "items": {
      "description": "The HRID settings for items",
      "type": "object",
      "$ref": "hridsetting.json"
    },
    "commonRetainLeadingZeroes": {
      "type": "boolean",
      "description": "If true, leading zeros should be applied for HRIDs",
      "default": true
    },
    "metadata": {
      "type": "object",
      "$ref": "raml-util/schemas/metadata.schema",
      "readonly": true
    }
  },
  "additionalProperties": false,
  "required": [
    "instances",
    "holdings",
    "items"
  ]
}

modify_hridSetting(hridSetting: dict)

Modifies HRID settings

PUT /hrid-settings-storage/hrid-settings

Parameters

hridSetting (dict) – See Schema below

Raises

OkapiRequestUnauthorized – Authentication is required
OkapiRequestForbidden – Forbidden
OkapiRequestFatalError – Server Error
OkapiRequestUnprocessableEntity – Unprocessable Entity

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "The HRID settings",
  "type": "object",
  "javaType": "org.folio.rest.jaxrs.model.HridSettings",
  "properties": {
    "id": {
      "description": "The ID of the one and only HRID settings record",
      "type": "string",
      "readonly": true,
      "$ref": "uuid.json"
    },
    "instances": {
      "description": "The HRID settings for instances",
      "type": "object",
      "$ref": "hridsetting.json"
    },
    "holdings": {
      "description": "The HRID settings for holdings",
      "type": "object",
      "$ref": "hridsetting.json"
    },
    "items": {
      "description": "The HRID settings for items",
      "type": "object",
      "$ref": "hridsetting.json"
    },
    "commonRetainLeadingZeroes": {
      "type": "boolean",
      "description": "If true, leading zeros should be applied for HRIDs",
      "default": true
    },
    "metadata": {
      "type": "object",
      "$ref": "raml-util/schemas/metadata.schema",
      "readonly": true
    }
  },
  "additionalProperties": false,
  "required": [
    "instances",
    "holdings",
    "items"
  ]
}