foliolib.folio.api.circulation.ChangeDueDate

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

Bases: foliolib.folio.FolioApi

API for changing due date for loans

Change loan due date API

Parameters
  • tenant (str) – Tenant id

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

Methods

set_changeDueDate(loansId, changeDueDate)

POST /circulation/loans/{loansId}/change-due-date

set_changeDueDate(loansId: str, changeDueDate: dict)

POST /circulation/loans/{loansId}/change-due-date

Parameters
  • loansId (str) –

  • changeDueDate (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 change loan due date API",
  "properties": {
    "dueDate": {
      "description": "The date and time when the loan is due",
      "type": "string",
      "format": "date-time"
    }
  },
  "additionalProperties": false,
  "required": [
    "dueDate"
  ]
}