foliolib.folio.api.consortia.ConsortiaConfiguration

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

Bases: foliolib.folio.FolioApi

Consortia Configuration integration API

Consortia Configuration integration API

Parameters
  • tenant (str) – Tenant id

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

Methods

getconfiguration()

GET /consortia-configuration

saveconfiguration(consortiaConfiguration)

POST /consortia-configuration

getconfiguration()

GET /consortia-configuration

Returns

See Schema below.

Return type

dict

Raises
  • OkapiRequestError – Bad request

  • OkapiFatalError – Internal server error

Schema

{
    "type": "object",
    "description": "Consortia Configuration",
    "properties": {
        "id": {
            "type": "string",
            "format": "uuid"
        },
        "centralTenantId": {
            "type": "string"
        }
    },
    "additionalProperties": false,
    "required": [
        "centralTenantId"
    ]
}
saveconfiguration(consortiaConfiguration)

POST /consortia-configuration

Parameters

consortiaConfiguration (dict) – See Schema below.

Returns

See Schema below.

Return type

dict

Raises
  • OkapiRequestError – Bad request

  • OkapiRequestConflict – Validation errors

  • OkapiFatalError – Internal server error

Schema

{
    "type": "object",
    "description": "Consortia Configuration",
    "properties": {
        "id": {
            "type": "string",
            "format": "uuid"
        },
        "centralTenantId": {
            "type": "string"
        }
    },
    "additionalProperties": false,
    "required": [
        "centralTenantId"
    ]
}