foliolib.folio.api.fincConfig.Isils

class foliolib.folio.api.fincConfig.Isils(tenant: str, okapi: Optional[foliolib.okapi.okapiClient.OkapiClient] = None)

Bases: foliolib.folio.FolioApi

mod-finc-config Isils API

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

Parameters

  • tenant (str) – Tenant id

  • okapi (OkapiClient, optional) – Instance of OkapiClient. Defaults to None.

Methods

delete_isil(isilsId)

Delete isil item with given {isilId}

get_isil(isilsId)

Retrieve isil item with given {isilId}

get_isils(**kwargs)

Return a list of isisls

modify_isil(isilsId, isil)

Update isil item with given {isilId}

set_isil(isil)

Create an isil
delete_isil(isilsId: str)

Delete isil item with given {isilId}

DELETE /finc-config/isils/{isilsId}

Parameters

isilsId (str) –

Raises

  • OkapiRequestNotFound – Not Found

  • OkapiRequestError – Bad Request

  • OkapiFatalError – Server Error

get_isil(isilsId: str)

Retrieve isil item with given {isilId}

GET /finc-config/isils/{isilsId}

Parameters

isilsId (str) –

Returns

See Schema below

Return type

dict

Raises

  • OkapiRequestNotFound – Not Found

  • OkapiFatalError – Server Error

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "title": "Isil",
  "description": "Isil to tenant configuration",
  "properties": {
    "id": {
      "description": "A UUID identifying this group",
      "type": "string"
    },
    "library": {
      "description": "Descriptive name of the library",
      "type": "string"
    },
    "isil": {
      "description": "Isil of this library",
      "type": "string"
    },
    "tenant": {
      "description": "Tenant of this library",
      "type": "string"
    },
    "metadata": {
      "$ref": "../raml-util/schemas/metadata.schema",
      "readonly": true
    }
  },
  "required": [
    "library",
    "isil",
    "tenant"
  ]
}
get_isils(**kwargs)

Return a list of isisls

GET /finc-config/isils

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.

    Example

    • (username==”ab*” or personal.firstName==”ab*” or personal.lastName==”ab*”) and active==”true” sortby personal.lastName personal.firstName barcode

  • 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

  • OkapiFatalError – Server Error

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "description": "Collection of isil to tenant configurations",
  "properties": {
    "isils": {
      "description": "List of isil items",
      "id": "isils",
      "type": "array",
      "items": {
        "type": "object",
        "$ref": "isil.json"
      }
    },
    "totalRecords": {
      "type": "integer"
    }
  }
}
modify_isil(isilsId: str, isil: dict)

Update isil item with given {isilId}

PUT /finc-config/isils/{isilsId}

Parameters

  • isilsId (str) –

  • isil (dict) – See Schema below

Raises

  • OkapiRequestNotFound – Not Found

  • OkapiRequestError – Bad Request

  • OkapiFatalError – Server Error

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "title": "Isil",
  "description": "Isil to tenant configuration",
  "properties": {
    "id": {
      "description": "A UUID identifying this group",
      "type": "string"
    },
    "library": {
      "description": "Descriptive name of the library",
      "type": "string"
    },
    "isil": {
      "description": "Isil of this library",
      "type": "string"
    },
    "tenant": {
      "description": "Tenant of this library",
      "type": "string"
    },
    "metadata": {
      "$ref": "../raml-util/schemas/metadata.schema",
      "readonly": true
    }
  },
  "required": [
    "library",
    "isil",
    "tenant"
  ]
}
set_isil(isil: dict)

Create an isil

POST /finc-config/isils

Parameters

isil (dict) – See Schema below

Raises

  • OkapiRequestError – Bad Request

  • OkapiRequestUnauthorized – Authentication is required

  • OkapiFatalError – Server Error

  • OkapiRequestUnprocessableEntity – Unprocessable Entity

Headers

  • Location - URI to the created isil item

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "title": "Isil",
  "description": "Isil to tenant configuration",
  "properties": {
    "id": {
      "description": "A UUID identifying this group",
      "type": "string"
    },
    "library": {
      "description": "Descriptive name of the library",
      "type": "string"
    },
    "isil": {
      "description": "Isil of this library",
      "type": "string"
    },
    "tenant": {
      "description": "Tenant of this library",
      "type": "string"
    },
    "metadata": {
      "$ref": "../raml-util/schemas/metadata.schema",
      "readonly": true
    }
  },
  "required": [
    "library",
    "isil",
    "tenant"
  ]
}