foliolib.folio.api.circulationStorage.AnonymizeStorageLoans

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

Bases: foliolib.folio.FolioApi

Anonymize loans API

Anonymize loans API

Parameters

• tenant (str) – Tenant id

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

Methods

set_anonymizeStorageLoan(anonymizeStorageLoan)

POST /anonymize-storage-loans

set_anonymizeStorageLoan(anonymizeStorageLoan: dict)

POST /anonymize-storage-loans

Parameters

anonymizeStorageLoan (dict) – See Schema below

Returns

See Schema below

Return type

dict

Raises

• OkapiFatalError – Server Error

• OkapiRequestUnprocessableEntity – Unprocessable Entity

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "Request schema for anonymize loans",
  "type": "object",
  "properties": {
    "loanIds": {
      "description": "Loan ids to be anonymized",
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  },
  "additionalProperties": false
}

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "Response schema for anonymize loans request",
  "type": "object",
  "properties": {
    "anonymizedLoans": {
      "description": "Successfully anonymized loan ids",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "notAnonymizedLoans": {
      "type": "array",
      "items": {
        "description": "Collection of loans",
        "type": "object",
        "properties": {
          "reason": {
            "description": "Reason of failure",
            "type": "string"
          },
          "loanIds": {
            "description": "List of loan IDs that have not been anonymized",
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        },
        "additionalProperties": false
      }
    }
  },
  "additionalProperties": false
}