foliolib.folio.api.finance.Groups

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

Bases: foliolib.folio.FolioApi

Group API

This documents the API calls that can be made to manage groups

Parameters

• tenant (str) – Tenant id

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

Methods

delete_group(groupsId)	Delete group item with given {groupId}
get_expenseClassesTotals(groupsId)	Retrieve expenseClassesTotal item with given {expenseClassesTotalId}
get_group(groupsId)	Retrieve group item with given {groupId}
get_groups(**kwargs)	Retrieve a list of group items.
modify_group(groupsId, group)	Update group item with given {groupId}
set_group(group)	Create a new group item.

delete_group(groupsId: str)

Delete group item with given {groupId}

DELETE /finance/groups/{groupsId}

Parameters

groupsId (str) –

Raises

• OkapiRequestNotFound – Not Found

• OkapiRequestError – Bad Request

• OkapiFatalError – Server Error

get_expenseClassesTotals(groupsId: str)

Retrieve expenseClassesTotal item with given {expenseClassesTotalId}

GET /finance/groups/{groupsId}/expense-classes-totals

Parameters

groupsId (str) –

Returns

See Schema below

Return type

dict

Raises

• OkapiRequestError – Bad Request

• OkapiRequestUnauthorized – Authentication is required

• OkapiRequestNotFound – Not Found

• OkapiFatalError – Server Error

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "A collection of group expense class total records",
  "type": "object",
  "properties": {
    "groupExpenseClassTotals": {
      "description": "The list of group expense class total objects contained in this collection",
      "type": "array",
      "items": {
        "type": "object",
        "$ref": "group_expense_class_totals.json"
      }
    },
    "totalRecords": {
      "description": "The number of objects contained in this collection",
      "type": "integer"
    }
  },
  "additionalProperties": false,
  "required": [
    "groupExpenseClassTotals",
    "totalRecords"
  ]
}

get_group(groupsId: str)

Retrieve group item with given {groupId}

GET /finance/groups/{groupsId}

Parameters

groupsId (str) –

Returns

See Schema below

Return type

dict

Raises

• OkapiRequestNotFound – Not Found

• OkapiFatalError – Server Error

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "User Group Schema",
  "description": "A user group",
  "type": "object",
  "properties": {
    "group": {
      "description": "The unique name of this group",
      "type": "string"
    },
    "desc": {
      "description": "An explanation of this group",
      "type": "string"
    },
    "id": {
      "description": "A UUID identifying this group",
      "type": "string"
    },
    "expirationOffsetInDays": {
      "description": "The default period in days after which a newly created user that belongs to this group will expire",
      "type": "integer"
    },
    "source": {
      "description": "Origin of the group record, i.e. 'System' or 'User'",
      "type": "string"
    },
    "metadata": {
      "$ref": "raml-util/schemas/metadata.schema",
      "readonly": true
    }
  },
  "required": [
    "group"
  ]
}

get_groups(**kwargs)

Retrieve a list of group items.

GET /finance/groups

Parameters

**kwargs (properties) – Keyword Arguments

Keyword Arguments

• 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

• 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: for example code

  Example

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

  • [“code”, “MEDGRANT”, “=”]

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 user groups",
  "properties": {
    "usergroups": {
      "description": "List of user group items",
      "id": "groups",
      "type": "array",
      "items": {
        "type": "object",
        "$ref": "usergroup.json"
      }
    },
    "totalRecords": {
      "type": "integer"
    }
  }
}

modify_group(groupsId: str, group: dict)

Update group item with given {groupId}

PUT /finance/groups/{groupsId}

Parameters

• groupsId (str) –

• group (dict) – See Schema below

Raises

• OkapiRequestNotFound – Not Found

• OkapiRequestError – Bad Request

• OkapiRequestConflict – Conflict

• OkapiFatalError – Server Error

• OkapiRequestUnprocessableEntity – Unprocessable Entity

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "User Group Schema",
  "description": "A user group",
  "type": "object",
  "properties": {
    "group": {
      "description": "The unique name of this group",
      "type": "string"
    },
    "desc": {
      "description": "An explanation of this group",
      "type": "string"
    },
    "id": {
      "description": "A UUID identifying this group",
      "type": "string"
    },
    "expirationOffsetInDays": {
      "description": "The default period in days after which a newly created user that belongs to this group will expire",
      "type": "integer"
    },
    "source": {
      "description": "Origin of the group record, i.e. 'System' or 'User'",
      "type": "string"
    },
    "metadata": {
      "$ref": "raml-util/schemas/metadata.schema",
      "readonly": true
    }
  },
  "required": [
    "group"
  ]
}

set_group(group: dict)

Create a new group item.

POST /finance/groups

Parameters

group (dict) – See Schema below

Raises

• OkapiRequestError – Bad Request

• OkapiRequestUnauthorized – Authentication is required

• OkapiFatalError – Server Error

• OkapiRequestUnprocessableEntity – Unprocessable Entity

Headers

• Location - URI to the created group item

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "User Group Schema",
  "description": "A user group",
  "type": "object",
  "properties": {
    "group": {
      "description": "The unique name of this group",
      "type": "string"
    },
    "desc": {
      "description": "An explanation of this group",
      "type": "string"
    },
    "id": {
      "description": "A UUID identifying this group",
      "type": "string"
    },
    "expirationOffsetInDays": {
      "description": "The default period in days after which a newly created user that belongs to this group will expire",
      "type": "integer"
    },
    "source": {
      "description": "Origin of the group record, i.e. 'System' or 'User'",
      "type": "string"
    },
    "metadata": {
      "$ref": "raml-util/schemas/metadata.schema",
      "readonly": true
    }
  },
  "required": [
    "group"
  ]
}