foliolib.folio.api.circulation.AddInfo

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

Bases: foliolib.folio.FolioApi

API for adding patron or staff info

Add info API

Parameters

• tenant (str) – Tenant id

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

Methods

set_addInfo(loansId, addInfo)

POST /circulation/loans/{loansId}/add-info

set_addInfo(loansId: str, addInfo: dict)

POST /circulation/loans/{loansId}/add-info

Parameters

• loansId (str) –

• addInfo (dict) – See Schema below

Raises

• OkapiRequestUnprocessableEntity – Unprocessable Entity

• OkapiRequestNotFound – Not Found

• OkapiFatalError – Server Error

• OkapiRequestUnprocessableEntity – Unprocessable Entity

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "description": "Request body schema for API for adding staff or patron info",
  "properties": {
    "action": {
      "description": "They category of info added",
      "type": "string",
      "enum": [
        "staffInfoAdded",
        "patronInfoAdded"
      ]
    },
    "actionComment": {
      "description": "Free text info",
      "type": "string"
    }
  },
  "additionalProperties": false,
  "required": [
    "action",
    "actionComment"
  ]
}