foliolib.folio.api.consortia.Consortia

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

Bases: foliolib.folio.FolioApi

Consortium integration API

Parameters

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

Methods

`getconsortium`(consortiumId)	`GET /consortia/{consortiumId}`
`getconsortiumcollection`()	`GET /consortia`
`saveconsortium`(consortium)	`POST /consortia`
`updateconsortium`(consortiumId, consortium)	`PUT /consortia/{consortiumId}`

getconsortium(consortiumId)

GET /consortia/{consortiumId}

Parameters

consortiumId (str) –

Returns

See Schema below.

Return type

dict

Raises

OkapiRequestError – Bad request
OkapiFatalError – Internal server error

Schema

{
    "type": "object",
    "description": "Consortium",
    "properties": {
        "id": {
            "type": "string",
            "format": "uuid"
        },
        "name": {
            "type": "string"
        }
    },
    "additionalProperties": false,
    "required": [
        "id",
        "name"
    ]
}

getconsortiumcollection()

GET /consortia

Returns

See Schema below.

Return type

dict

Raises

OkapiRequestError – Bad request
OkapiFatalError – Internal server error

Schema

{
    "type": "object",
    "description": "A JSON schema for the Consortium Collection",
    "properties": {
        "consortia": {
            "type": "array",
            "description": "The list of consortia",
            "items": {
                "type": "object",
                "$ref": "consortium.yaml#/Consortium"
            }
        },
        "totalRecords": {
            "type": "integer"
        }
    },
    "additionalProperties": false,
    "required": [
        "consortia",
        "totalRecords"
    ]
}

saveconsortium(consortium)

POST /consortia

Parameters

consortium (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": "Consortium",
    "properties": {
        "id": {
            "type": "string",
            "format": "uuid"
        },
        "name": {
            "type": "string"
        }
    },
    "additionalProperties": false,
    "required": [
        "id",
        "name"
    ]
}

updateconsortium(consortiumId, consortium)

PUT /consortia/{consortiumId}

Parameters

consortiumId (str) –
consortium (dict) – See Schema below.

Returns

See Schema below.

Return type

dict

Raises

OkapiRequestError – Bad request
OkapiRequestNotFound – Resource not found
OkapiFatalError – Internal server error

Schema

{
    "type": "object",
    "description": "Consortium",
    "properties": {
        "id": {
            "type": "string",
            "format": "uuid"
        },
        "name": {
            "type": "string"
        }
    },
    "additionalProperties": false,
    "required": [
        "id",
        "name"
    ]
}