foliolib.folio.api.quickMarc.Recordseditorasync

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

Bases: foliolib.folio.FolioApi

quickMARC Record Editor

Parameters

  • tenant (str) – Tenant id

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

Methods

deleterecordbyexternalid(id_)

Delete MARC record by externalId

putrecord(quickMarcEdit, id_)

Edit MARC record
deleterecordbyexternalid(id_)

Delete MARC record by externalId

DELETE /records-editor/records/{id}

Raises

  • OkapiRequestError – Bad request, e.g. malformed request body or query parameter. Details of the error (e.g. name of the parameter or line/character number with malformed data) provided in the response.

  • OkapiRequestNotFound – MARC record with a given ID not found

  • OkapiFatalError – Internal server error, e.g. due to misconfiguration

putrecord(quickMarcEdit, id_)

Edit MARC record

PUT /records-editor/records/{id}

Parameters

quickMarcEdit (dict) – See Schema below.

Raises

  • OkapiRequestError – Bad request, e.g. malformed request body or query parameter. Details of the error (e.g. name of the parameter or line/character number with malformed data) provided in the response.

  • OkapiRequestConflict – Update failed due to optimistic locking

  • OkapiFatalError – Internal server error, e.g. due to misconfiguration

Schema

{
    "allOf": [
        {
            "$ref": "#/baseMarcRecord"
        },
        {
            "type": "object",
            "properties": {
                "parsedRecordId": {
                    "description": "MARC record Id",
                    "$ref": "#/uuid"
                },
                "parsedRecordDtoId": {
                    "description": "ParsedRecordDto identifier",
                    "$ref": "#/uuid"
                },
                "externalId": {
                    "description": "Identifier of external entity",
                    "$ref": "#/uuid"
                },
                "externalHrid": {
                    "description": "HRID of external entity",
                    "type": "string"
                },
                "relatedRecordVersion": {
                    "description": "Information related to version of the record",
                    "type": "string"
                }
            },
            "required": [
                "parsedRecordId",
                "parsedRecordDtoId",
                "externalId",
                "externalHrid",
                "relatedRecordVersion"
            ]
        }
    ]
}