foliolib.folio.api.circulation.InventoryReports
- class foliolib.folio.api.circulation.InventoryReports(tenant: str, okapi: Optional[foliolib.okapi.okapiClient.OkapiClient] = None)
Bases:
foliolib.folio.FolioApiCirculation Business Logic API
API for report generation
- Parameters
tenant (str) – Tenant id
okapi (OkapiClient, optional) – Instance of OkapiClient. Defaults to None.
Methods
Retrieve itemsInTransit item with given {itemsInTransitId}
- get_itemsInTransits()
Retrieve itemsInTransit item with given {itemsInTransitId}
GET /inventory-reports/items-in-transit- Returns
See Schema below
- Return type
dict
- Raises
OkapiRequestError – Bad Request
OkapiRequestUnauthorized – Authentication is required
OkapiRequestNotFound – Not Found
OkapiFatalError – Server Error
Schema
{ "$schema": "http://json-schema.org/draft-04/schema#", "title": "Collection of items", "description": "Collection of items", "type": "object", "properties": { "items": { "description": "Paged collection of items", "id": "items", "type": "array", "items": { "title": "An item", "description": "Full information about an item", "type": "object", "properties": { "id": { "description": "UUID of the item", "type": "string", "$ref": "uuid.json" }, "title": { "description": "title of the item (stored)", "type": "string" }, "barcode": { "description": "barcode of the item (stored)", "type": "string" }, "contributors": { "description": "A list of contributor names", "type": "array", "items": { "type": "object", "additionalProperties": false, "properties": { "name": { "description": "The contributor name", "type": "string" } } } }, "callNumber": { "description": "The call number from the holdings record", "type": "string" }, "enumeration": { "description": "The enumeration of the item", "type": "string" }, "volume": { "description": "The volume of the item", "type": "string" }, "yearCaption": { "description": "The year caption of the item", "type": "array", "items": { "type": "string" } }, "status": { "description": "The status for an item (should be In transit for all items in report)", "type": "object", "additionalProperties": false, "properties": { "name": { "type": "string", "description": "The name of the status" } } }, "inTransitDestinationServicePointId": { "description": "Destination service point: the service point where the item was sent as a result of its most recent scan in the check in app", "type": "string" }, "inTransitDestinationServicePoint": { "description": "Service point an item is intended to be transited to (should only be present when in transit)", "type": "object", "properties": { "id": { "description": "UUID of the service point", "type": "string", "$ref": "uuid.json" }, "name": { "description": "Name of the service point", "type": "string" } } }, "location": { "description": "The effective location of the item", "type": "object", "additionalProperties": false, "properties": { "name": { "type": "string", "description": "The name of the location" }, "libraryName": { "type": "string", "description": "The name of the library of the location" }, "code": { "type": "string", "description": "The location code" } } }, "request": { "description": "The first open item's request in the queue", "type": "object", "additionalProperties": false, "properties": { "requestType": { "type": "string", "description": "The type of the request" }, "requestDate": { "description": "Date the request was made", "type": "string", "format": "date-time" }, "requestExpirationDate": { "description": "Date when the request expires", "type": "string", "format": "date-time" }, "requestPickupServicePointName": { "description": "The name of the request pickup service point", "type": "string" }, "requestPatronGroup": { "type": "string", "description": "The patron group of the request" }, "tags": { "description": "List of tags", "type": "array", "items": { "type": "string" } } } }, "loan": { "description": "The effective location of the item", "type": "object", "additionalProperties": false, "properties": { "checkInServicePoint": { "description": "The check in service point", "type": "object", "additionalProperties": false, "properties": { "name": { "type": "string", "description": "The name of the service point" }, "code": { "type": "string", "description": "The location code of the service point" }, "discoveryDisplayName": { "type": "string", "description": "The discovery display name of the service point" }, "shelvingLagTime": { "description": "Shelving lag time", "type": "integer" }, "pickupLocation": { "description": "Is this a pickup location", "type": "boolean" } } }, "checkInDateTime": { "description": "Date when the item is checked in", "type": "string", "format": "date-time" } } }, "lastCheckIn": { "description": "The information about when an item was last scanned", "type": "object", "additionalProperties": false, "properties": { "dateTime": { "description": "The date and time when the item was most recently scanned", "type": "string", "format": "date-time" }, "servicePoint": { "description": "The service point where the item was most recently scanned in the Check In app", "type": "object", "additionalProperties": false, "properties": { "id": { "description": "UUID of the service point", "type": "string", "$ref": "uuid.json" }, "name": { "type": "string", "description": "The name of the service point" } } } } }, "copyNumber": { "type": "string", "description": "Copy number is the piece identifier. The copy number reflects if the library has a copy of a single-volume monograph; one copy of a multi-volume, (e.g. Copy 1, or C.7.)" }, "effectiveCallNumberComponents": { "description": "Elements of a full call number", "$ref": "schema/call-number-components.json" } }, "additionalProperties": false } }, "totalRecords": { "description": "Total number of items", "type": "integer" } }, "required": [ "items", "totalRecords" ] }