foliolib.folio.api.circulation.ClaimItemReturned

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

Bases: foliolib.folio.FolioApi

API for declaring loaned item as claimed returned

Claim item returned API

Parameters

• tenant (str) – Tenant id

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

Methods

set_claimItemReturned(loansId, claimItemReturned)	POST /circulation/loans/{loansId}/claim-item-returned
set_declareClaimedReturnedItemAsMissing(...)	POST /circulation/loans/{loansId}/declare-claimed-returned-item-as-missing

set_claimItemReturned(loansId: str, claimItemReturned: dict)

POST /circulation/loans/{loansId}/claim-item-returned

Parameters

• loansId (str) –

• claimItemReturned (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 claim item returned API",
  "properties": {
    "itemClaimedReturnedDateTime": {
      "description": "The date and time when the item is to be claimed returned",
      "type": "string",
      "format": "date-time"
    },
    "comment": {
      "description": "Comment explaining why the item has been claimed returned",
      "type": "string"
    }
  },
  "additionalProperties": false,
  "required": [
    "itemClaimedReturnedDateTime"
  ]
}

set_declareClaimedReturnedItemAsMissing(loansId: str, declareClaimedReturnedItemAsMissing: dict)

POST /circulation/loans/{loansId}/declare-claimed-returned-item-as-missing

Parameters

• loansId (str) –

• declareClaimedReturnedItemAsMissing (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 resolving claim as missing API",
  "properties": {
    "comment": {
      "description": "Comment explaining why the item has been marked missing",
      "type": "string"
    }
  },
  "additionalProperties": false,
  "required": [
    "comment"
  ]
}