GET OneStop/Groups/{GroupID}/Devices/{DeviceID}/Consumables/{ConsumableID}/History
Get history for specified consumable. An new entry is added each time a consumable change is processed
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| GroupID | integer |
Required |
|
| DeviceID |
ID of Device to Get |
integer |
Required |
| ConsumableID |
Consumable to get |
integer |
Required |
Body Parameters
None.
Response Information
Resource Description
ConsumableHistoryDTO| Name | Description | Type | Additional information |
|---|---|---|---|
| ConsumableHistoryID |
History ID |
integer |
None. |
| ConsumableID |
Consumable ID |
integer |
None. |
| InsertDate |
Date consumable inserted into device. For first consumable history, this may be date device added to system |
date |
None. |
| ChangeDate |
Date consumable change |
date |
None. |
| InsertTotalMono |
Device mono count when consumable inserted |
integer |
None. |
| InsertTotalColour |
Device colour count when consumable inserted |
integer |
None. |
| InsertDeviceTotal |
Device total count when consumable inserted |
integer |
None. |
| ChangeTotalMono |
Device mono count when consumable changed |
integer |
None. |
| ChangeTotalColour |
Device colour count when consumable changed |
integer |
None. |
| ChangeDeviceTotal |
Device total count when consumable inserted |
integer |
None. |
| SerialNumber |
Consumable serial number, if reported |
string |
None. |
| OrderID |
Order ID raised when consumable reached a threshold |
integer |
None. |
| InsertLevel |
Level when consumable inserted ie 100% |
integer |
None. |
| LastLevel |
Level before consumable changed ie 4% |
integer |
None. |
| ChangeLevel |
Level after consumable changed ie 99% |
integer |
None. |
| ActualYield |
Calculated yield of consumable |
decimal number |
None. |
Response Formats
application/json, text/json
{
"ConsumableHistoryID": 1,
"ConsumableID": 2,
"InsertDate": "2026-07-07T14:50:16.1023393+01:00",
"ChangeDate": "2026-07-07T14:50:16.1023393+01:00",
"InsertTotalMono": 1,
"InsertTotalColour": 1,
"InsertDeviceTotal": 1,
"ChangeTotalMono": 1,
"ChangeTotalColour": 1,
"ChangeDeviceTotal": 1,
"SerialNumber": "sample string 5",
"OrderID": 1,
"InsertLevel": 6,
"LastLevel": 7,
"ChangeLevel": 8,
"ActualYield": 1.0
}
application/xml, text/xml
<ConsumableHistoryDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneStopWebAPI.DTO"> <ActualYield>1</ActualYield> <ChangeDate>2026-07-07T14:50:16.1023393+01:00</ChangeDate> <ChangeDeviceTotal>1</ChangeDeviceTotal> <ChangeLevel>8</ChangeLevel> <ChangeTotalColour>1</ChangeTotalColour> <ChangeTotalMono>1</ChangeTotalMono> <ConsumableHistoryID>1</ConsumableHistoryID> <ConsumableID>2</ConsumableID> <InsertDate>2026-07-07T14:50:16.1023393+01:00</InsertDate> <InsertDeviceTotal>1</InsertDeviceTotal> <InsertLevel>6</InsertLevel> <InsertTotalColour>1</InsertTotalColour> <InsertTotalMono>1</InsertTotalMono> <LastLevel>7</LastLevel> <OrderID>1</OrderID> <SerialNumber>sample string 5</SerialNumber> </ConsumableHistoryDTO>