foliolib.folio.api.consortiaKeycloak.SharingSettings

class foliolib.folio.api.consortiaKeycloak.SharingSettings(tenant: str)

Bases: foliolib.folio.FolioApi

Sharing instance and setting integration API

Sharing instance and setting integration API

Base class of the Folio API

Parameters

tenant (str) – Tenant id

Methods

deletesharingsetting(consortiumId, ...)	DELETE /consortia/{consortiumId}/sharing/settings/{settingId}
startsharingsetting(consortiumId, ...)	POST /consortia/{consortiumId}/sharing/settings

deletesharingsetting(consortiumId, settingId, sharingSettingRequest)

DELETE /consortia/{consortiumId}/sharing/settings/{settingId}

Parameters

• consortiumId (str) –

• settingId (str) –

• sharingSettingRequest (dict) – See Schema below.

Returns

See Schema below.

Return type

dict

Raises

• OkapiRequestError – Bad request

• OkapiRequestNotFound – Resource not found

• OkapiRequestConflict – Validation errors

• OkapiRequestUnprocessableEntity – Validation errors

• OkapiRequestFatalError – Internal server error

Schema

{
    "description": "A JSON schema for the Sharing settings object",
    "type": "object",
    "properties": {
        "settingId": {
            "description": "id of sharing setting record",
            "type": "string",
            "format": "uuid"
        },
        "url": {
            "description": "URL for publishing requests for consortia tenants",
            "type": "string"
        },
        "payload": {
            "description": "Http request body",
            "type": "object"
        }
    },
    "additionalProperties": false,
    "required": [
        "settingId",
        "url"
    ]
}

{
    "description": "A JSON schema for the Sharing settings object response for delete request",
    "type": "object",
    "properties": {
        "pcId": {
            "type": "string",
            "format": "uuid"
        }
    },
    "additionalProperties": false,
    "required": [
        "pcId"
    ]
}

startsharingsetting(consortiumId, sharingSettingRequest)

POST /consortia/{consortiumId}/sharing/settings

Parameters

• consortiumId (str) –

• sharingSettingRequest (dict) – See Schema below.

Returns

See Schema below.

Return type

dict

Raises

• OkapiRequestError – Bad request

• OkapiRequestNotFound – Resource not found

• OkapiRequestConflict – Validation errors

• OkapiRequestUnprocessableEntity – Validation errors

• OkapiRequestFatalError – Internal server error

Schema

{
    "description": "A JSON schema for the Sharing settings object",
    "type": "object",
    "properties": {
        "settingId": {
            "description": "id of sharing setting record",
            "type": "string",
            "format": "uuid"
        },
        "url": {
            "description": "URL for publishing requests for consortia tenants",
            "type": "string"
        },
        "payload": {
            "description": "Http request body",
            "type": "object"
        }
    },
    "additionalProperties": false,
    "required": [
        "settingId",
        "url"
    ]
}

{
    "description": "A JSON schema for the Sharing settings object response for post request",
    "type": "object",
    "properties": {
        "createSettingsPCId": {
            "type": "string",
            "format": "uuid"
        },
        "updateSettingsPCId": {
            "type": "string",
            "format": "uuid"
        }
    },
    "additionalProperties": false,
    "required": [
        "createSettingsPCId",
        "updateSettingsPCId"
    ]
}