foliolib.folio.api.circulation.DeclareItemLost

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

Bases: foliolib.folio.FolioApi

API for declaring loaned item lost

Declare item lost API

Parameters

• tenant (str) – Tenant id

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

Methods

set_declareItemLost(loansId, declareItemLost)

POST /circulation/loans/{loansId}/declare-item-lost

set_declareItemLost(loansId: str, declareItemLost: dict)

POST /circulation/loans/{loansId}/declare-item-lost

Parameters

• loansId (str) –

• declareItemLost (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 declare item lost API",
  "properties": {
    "declaredLostDateTime": {
      "description": "The date and time when the item is to be declared lost",
      "type": "string",
      "format": "date-time"
    },
    "comment": {
      "description": "Comment explaining why the item has been declared lost",
      "type": "string"
    },
    "servicePointId": {
      "description": "Current service point, where the item is being declared lost",
      "type": "string",
      "$ref": "uuid.json"
    }
  },
  "required": [
    "declaredLostDateTime",
    "servicePointId"
  ]
}