foliolib.folio.api.circulation.LoanAnonymization

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

Bases: foliolib.folio.FolioApi

Loan Anonymization API

Loan Anonymization API

Parameters

• tenant (str) – Tenant id

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

Methods

set_byUser(userId)

Note that a 422 error with haveAssociatedFeesAndFines message and key loanIds has a value that is not a JSON array but a JSON string that contains a serialized JSON array of the loan ids.

set_byUser(userId: str)

Note that a 422 error with haveAssociatedFeesAndFines message and key loanIds has a value that is not a JSON array but a JSON string that contains a serialized JSON array of the loan ids.

POST /loan-anonymization/by-user/{userId}

Parameters

userId (str) –

Returns

See Schema below

Return type

dict

Raises

• OkapiFatalError – Server Error

• OkapiRequestUnprocessableEntity – Unprocessable Entity

Schema

{
  "$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"
      }
    },
    "errors": {
      "description": "List of errors",
      "id": "errors",
      "type": "array",
      "items": {
        "type": "object",
        "$ref": "../raml-util/schemas/error.schema"
      }
    }
  },
  "additionalProperties": false
}