foliolib.folio.api.consortia.Self

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

Bases: foliolib.folio.FolioApi

Self integration API

Parameters

tenant (str) – Tenant id
okapi (OkapiClient, optional) – Instance of OkapiClient. Defaults to None.

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
OkapiFatalError – 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"
    ]
}