foliolib.folio.api.inventoryStorage.AlternativeTitleType

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

Bases: foliolib.folio.FolioApi

Alternative title types API

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

Base class of the Folio API

Parameters

tenant (str) – Tenant id

Methods

delete_alternativeTitleType(...)	Delete alternativeTitleType item with given {alternativeTitleTypeId}
get_alternativeTitleType(alternativeTitleTypesId)	Retrieve alternativeTitleType item with given {alternativeTitleTypeId}
get_alternativeTitleTypes(**kwargs)	Return a list of alternative title types
modify_alternativeTitleType(...)	Update alternativeTitleType item with given {alternativeTitleTypeId}
set_alternativeTitleType(alternativeTitleType)	Create a new alternative title type

delete_alternativeTitleType(alternativeTitleTypesId: str)

Delete alternativeTitleType item with given {alternativeTitleTypeId}

DELETE /alternative-title-types/{alternativeTitleTypesId}

Parameters

alternativeTitleTypesId (str) –

Raises

• OkapiRequestNotFound – Not Found

• OkapiRequestError – Bad Request

• OkapiRequestFatalError – Server Error

get_alternativeTitleType(alternativeTitleTypesId: str)

Retrieve alternativeTitleType item with given {alternativeTitleTypeId}

GET /alternative-title-types/{alternativeTitleTypesId}

Parameters

alternativeTitleTypesId (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 call number type",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "unique ID of the alternative title type; a UUID"
    },
    "name": {
      "type": "string",
      "description": "name of the alternative title type"
    },
    "source": {
      "type": "string",
      "description": "label indicating where the alternative title 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_alternativeTitleTypes(**kwargs)

Return a list of alternative title types

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

modify_alternativeTitleType(alternativeTitleTypesId: str, alternativeTitleType: dict)

Update alternativeTitleType item with given {alternativeTitleTypeId}

PUT /alternative-title-types/{alternativeTitleTypesId}

Parameters

• alternativeTitleTypesId (str) –

• alternativeTitleType (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 call number type",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "unique ID of the alternative title type; a UUID"
    },
    "name": {
      "type": "string",
      "description": "name of the alternative title type"
    },
    "source": {
      "type": "string",
      "description": "label indicating where the alternative title 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_alternativeTitleType(alternativeTitleType: dict)

Create a new alternative title type

POST /alternative-title-types

Parameters

alternativeTitleType (dict) – See Schema below

Raises

• OkapiRequestError – Bad Request

• OkapiRequestUnauthorized – Authentication is required

• OkapiRequestFatalError – Server Error

• OkapiRequestUnprocessableEntity – Unprocessable Entity

Headers

• Location - URI to the created alternativeTitleType item

Schema

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