foliolib.folio.api.consortia.Self

class foliolib.folio.api.consortia.Self(tenant: str)

Bases: foliolib.folio.FolioApi

Self integration API

Base class of the Folio API

Parameters: tenant (str) – Tenant id

Methods

getusertenantsforcurrentuser(consortiumId)

GET /consortia/{consortiumId}/_self

getusertenantsforcurrentuser(consortiumId)

GET /consortia/{consortiumId}/_self

Parameters

consortiumId (str) –

Returns

See Schema below.

Return type

dict

Raises

OkapiRequestError – Bad request
OkapiRequestUnauthorized – Not authorized to perform requested action
OkapiRequestNotFound – Resource not found
OkapiRequestFatalError – Internal server error

Schema

{
    "description": "A JSON schema for the User Tenants Collection",
    "type": "object",
    "properties": {
        "userTenants": {
            "type": "array",
            "description": "The list of user tenants",
            "items": {
                "type": "object",
                "$ref": "userTenant.yaml#/UserTenant"
            }
        },
        "totalRecords": {
            "type": "integer"
        }
    },
    "additionalProperties": false,
    "required": [
        "userTenants",
        "totalRecords"
    ]
}