foliolib.folio.api.circulation.EndPatronActionSession

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

Bases: foliolib.folio.FolioApi

End Patron Action Session API

End patron action session

Parameters
  • tenant (str) – Tenant id

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

Methods

set_endPatronActionSession(...)

POST /circulation/end-patron-action-session

set_endPatronActionSession(endPatronActionSession: dict)

POST /circulation/end-patron-action-session

Parameters

endPatronActionSession (dict) – See Schema below

Raises
  • OkapiFatalError – Server Error

  • OkapiRequestUnprocessableEntity – Unprocessable Entity

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "description": "List of requests to end patron action sessions",
  "properties": {
    "endSessions": {
      "description": "List of requests to end patron action sessions",
      "id": "endSessions",
      "type": "array",
      "items": {
        "type": "object",
        "$ref": "end-patron-action-session-request.json"
      }
    },
    "totalRecords": {
      "type": "integer"
    }
  },
  "required": [
    "endSessions",
    "totalRecords"
  ]
}