GET OneStop/Groups/{GroupID}/Devices/{DeviceID}/Consumables
Gets consumable details for specified device
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| GroupID | integer |
Required |
|
| DeviceID |
ID of Device to Get |
integer |
Required |
Body Parameters
None.
Response Information
Resource Description
Collection of ConsumableDTO| Name | Description | Type | Additional information |
|---|---|---|---|
| ConsumableID |
Consumable ID |
integer |
None. |
| DeviceID |
Device ID |
integer |
None. |
| Colour |
Consumable colour, ie Black, Cyan etc |
string |
None. |
| Description |
Consumable description, from device |
string |
None. |
| ConsumableTypeDescription |
Consumable type, ie toner, drum etc |
string |
None. |
| ManufacturerID |
Internal ID of device manufacturer |
integer |
None. |
| ModelID |
Internal ID of device model |
integer |
None. |
| ConsumableType |
Numeric value of consumable type |
integer |
None. |
| ConsumableVariantID |
Variant ID. A consumable variant is specific to each type of consumble for each model of device |
integer |
None. |
| SerialNumber |
Consumable serial number, if supplied by device |
string |
None. |
| CurrentLevel |
Current consumable level |
integer |
None. |
| ConsumableLifeUsage |
Consumable life usage, if supplied by device. Only applies to some wide format devices |
decimal number |
None. |
| CurrentDeviceTotal |
Device total reading at last consumable reading |
integer |
None. |
| CurrentTotalColour |
Device total colour reading at last consumable reading |
integer |
None. |
| CurrentTotalMono |
Device total mono reading at last consumable reading |
integer |
None. |
| CurrentYield |
Current calculated yield |
decimal number |
None. |
| ExpectedYieldPageCount |
Consumable yield page count, as stated by manufacturer. Used to calculate actual yield |
integer |
None. |
| ExpectedYieldPercentage |
Consumable yield percent (normally 5%), as stated by manufacturer. Used to calculate actual yield |
decimal number |
None. |
| PartCode |
Manufacturers part code, if known |
string |
None. |
| PartNumber |
Manufacturers part number, if known |
string |
None. |
| Comment |
Any comments stored for consumable |
string |
None. |
| LastReadingDate |
Date last consumable reading taken |
date |
None. |
| LastCheckedDate |
Date last checked. Consumable readings are only actually taken if a level change, or 12 hours since last reading |
date |
None. |
| LastChangeDate |
Date the consumable was last changed |
date |
None. |
| LastChangeDeviceTotal |
Device total when consumable changed |
integer |
None. |
| LastChangeTotalColour |
Device colour total when consumable changed |
integer |
None. |
| LastChangeTotalMono |
Device mono total when consumable changed |
integer |
None. |
| LastChangeNewLevel |
Level of consumable immediately after change. Normally 100%, but not always... |
integer |
None. |
| OnOrder |
Whether there is a current order for this consumable |
boolean |
None. |
| DateOrderPlaced |
Date most recent order placed |
date |
None. |
| OrderReason |
Reason order was raised. 1=Days Between Change 2=Pages Between Change,3=Level Reached, 4=days Before Empty, 5=Manual Order,6=Consumable Status |
integer |
None. |
| OrderID |
Order ID |
integer |
None. |
| AllowThresholdOverwrite |
If set, threshold hold settings can be over written when changed at a group level |
boolean |
None. |
| AveragePageLifeCount |
Average page count for this consumable through it's entire history |
integer |
None. |
| AverageDaysLifeCount |
Average days between count for this consumable through it's entire history |
integer |
None. |
| ExpectedEmptyDate |
Calculated expected empty date |
date |
None. |
| DateAdded |
Date consumable added to system |
date |
None. |
| LastKnownLevel |
Last level that was between 0 and 100. Some and Unknown are ignored |
integer |
None. |
| Visible |
Whether this consumable is displayed |
boolean |
None. |
| LevelChangeCount |
Number of level changes detected for this consumable |
integer |
None. |
Response Formats
application/json, text/json
[
{
"ConsumableID": 1,
"DeviceID": 2,
"Colour": "sample string 3",
"Description": "sample string 4",
"ConsumableTypeDescription": "sample string 5",
"ManufacturerID": 6,
"ModelID": 7,
"ConsumableType": 8,
"ConsumableVariantID": 9,
"SerialNumber": "sample string 10",
"CurrentLevel": 11,
"ConsumableLifeUsage": 1.1,
"CurrentDeviceTotal": 12,
"CurrentTotalColour": 1,
"CurrentTotalMono": 1,
"CurrentYield": 1.0,
"ExpectedYieldPageCount": 1,
"ExpectedYieldPercentage": 1.0,
"PartCode": "sample string 13",
"PartNumber": "sample string 14",
"Comment": "sample string 15",
"LastReadingDate": "2026-07-07T14:50:16.0213333+01:00",
"LastCheckedDate": "2026-07-07T14:50:16.0213333+01:00",
"LastChangeDate": "2026-07-07T14:50:16.0213333+01:00",
"LastChangeDeviceTotal": 1,
"LastChangeTotalColour": 1,
"LastChangeTotalMono": 1,
"LastChangeNewLevel": 1,
"OnOrder": true,
"DateOrderPlaced": "2026-07-07T14:50:16.0223338+01:00",
"OrderReason": 1,
"OrderID": 1,
"AllowThresholdOverwrite": true,
"AveragePageLifeCount": 1,
"AverageDaysLifeCount": 1,
"ExpectedEmptyDate": "2026-07-07T14:50:16.0223338+01:00",
"DateAdded": "2026-07-07T14:50:16.0223338+01:00",
"LastKnownLevel": 1,
"Visible": true,
"LevelChangeCount": 19
},
{
"ConsumableID": 1,
"DeviceID": 2,
"Colour": "sample string 3",
"Description": "sample string 4",
"ConsumableTypeDescription": "sample string 5",
"ManufacturerID": 6,
"ModelID": 7,
"ConsumableType": 8,
"ConsumableVariantID": 9,
"SerialNumber": "sample string 10",
"CurrentLevel": 11,
"ConsumableLifeUsage": 1.1,
"CurrentDeviceTotal": 12,
"CurrentTotalColour": 1,
"CurrentTotalMono": 1,
"CurrentYield": 1.0,
"ExpectedYieldPageCount": 1,
"ExpectedYieldPercentage": 1.0,
"PartCode": "sample string 13",
"PartNumber": "sample string 14",
"Comment": "sample string 15",
"LastReadingDate": "2026-07-07T14:50:16.0213333+01:00",
"LastCheckedDate": "2026-07-07T14:50:16.0213333+01:00",
"LastChangeDate": "2026-07-07T14:50:16.0213333+01:00",
"LastChangeDeviceTotal": 1,
"LastChangeTotalColour": 1,
"LastChangeTotalMono": 1,
"LastChangeNewLevel": 1,
"OnOrder": true,
"DateOrderPlaced": "2026-07-07T14:50:16.0223338+01:00",
"OrderReason": 1,
"OrderID": 1,
"AllowThresholdOverwrite": true,
"AveragePageLifeCount": 1,
"AverageDaysLifeCount": 1,
"ExpectedEmptyDate": "2026-07-07T14:50:16.0223338+01:00",
"DateAdded": "2026-07-07T14:50:16.0223338+01:00",
"LastKnownLevel": 1,
"Visible": true,
"LevelChangeCount": 19
}
]
application/xml, text/xml
<ArrayOfConsumableDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneStopWebAPI.DTO">
<ConsumableDTO>
<AllowThresholdOverwrite>true</AllowThresholdOverwrite>
<AverageDaysLifeCount>1</AverageDaysLifeCount>
<AveragePageLifeCount>1</AveragePageLifeCount>
<Colour>sample string 3</Colour>
<Comment>sample string 15</Comment>
<ConsumableID>1</ConsumableID>
<ConsumableLifeUsage>1.1</ConsumableLifeUsage>
<ConsumableType>8</ConsumableType>
<ConsumableTypeDescription>sample string 5</ConsumableTypeDescription>
<ConsumableVariantID>9</ConsumableVariantID>
<CurrentDeviceTotal>12</CurrentDeviceTotal>
<CurrentLevel>11</CurrentLevel>
<CurrentTotalColour>1</CurrentTotalColour>
<CurrentTotalMono>1</CurrentTotalMono>
<CurrentYield>1</CurrentYield>
<DateAdded>2026-07-07T14:50:16.0223338+01:00</DateAdded>
<DateOrderPlaced>2026-07-07T14:50:16.0223338+01:00</DateOrderPlaced>
<Description>sample string 4</Description>
<DeviceID>2</DeviceID>
<ExpectedEmptyDate>2026-07-07T14:50:16.0223338+01:00</ExpectedEmptyDate>
<ExpectedYieldPageCount>1</ExpectedYieldPageCount>
<ExpectedYieldPercentage>1</ExpectedYieldPercentage>
<LastChangeDate>2026-07-07T14:50:16.0213333+01:00</LastChangeDate>
<LastChangeDeviceTotal>1</LastChangeDeviceTotal>
<LastChangeNewLevel>1</LastChangeNewLevel>
<LastChangeTotalColour>1</LastChangeTotalColour>
<LastChangeTotalMono>1</LastChangeTotalMono>
<LastCheckedDate>2026-07-07T14:50:16.0213333+01:00</LastCheckedDate>
<LastKnownLevel>1</LastKnownLevel>
<LastReadingDate>2026-07-07T14:50:16.0213333+01:00</LastReadingDate>
<LevelChangeCount>19</LevelChangeCount>
<ManufacturerID>6</ManufacturerID>
<ModelID>7</ModelID>
<OnOrder>true</OnOrder>
<OrderID>1</OrderID>
<OrderReason>1</OrderReason>
<PartCode>sample string 13</PartCode>
<PartNumber>sample string 14</PartNumber>
<SerialNumber>sample string 10</SerialNumber>
<Visible>true</Visible>
</ConsumableDTO>
<ConsumableDTO>
<AllowThresholdOverwrite>true</AllowThresholdOverwrite>
<AverageDaysLifeCount>1</AverageDaysLifeCount>
<AveragePageLifeCount>1</AveragePageLifeCount>
<Colour>sample string 3</Colour>
<Comment>sample string 15</Comment>
<ConsumableID>1</ConsumableID>
<ConsumableLifeUsage>1.1</ConsumableLifeUsage>
<ConsumableType>8</ConsumableType>
<ConsumableTypeDescription>sample string 5</ConsumableTypeDescription>
<ConsumableVariantID>9</ConsumableVariantID>
<CurrentDeviceTotal>12</CurrentDeviceTotal>
<CurrentLevel>11</CurrentLevel>
<CurrentTotalColour>1</CurrentTotalColour>
<CurrentTotalMono>1</CurrentTotalMono>
<CurrentYield>1</CurrentYield>
<DateAdded>2026-07-07T14:50:16.0223338+01:00</DateAdded>
<DateOrderPlaced>2026-07-07T14:50:16.0223338+01:00</DateOrderPlaced>
<Description>sample string 4</Description>
<DeviceID>2</DeviceID>
<ExpectedEmptyDate>2026-07-07T14:50:16.0223338+01:00</ExpectedEmptyDate>
<ExpectedYieldPageCount>1</ExpectedYieldPageCount>
<ExpectedYieldPercentage>1</ExpectedYieldPercentage>
<LastChangeDate>2026-07-07T14:50:16.0213333+01:00</LastChangeDate>
<LastChangeDeviceTotal>1</LastChangeDeviceTotal>
<LastChangeNewLevel>1</LastChangeNewLevel>
<LastChangeTotalColour>1</LastChangeTotalColour>
<LastChangeTotalMono>1</LastChangeTotalMono>
<LastCheckedDate>2026-07-07T14:50:16.0213333+01:00</LastCheckedDate>
<LastKnownLevel>1</LastKnownLevel>
<LastReadingDate>2026-07-07T14:50:16.0213333+01:00</LastReadingDate>
<LevelChangeCount>19</LevelChangeCount>
<ManufacturerID>6</ManufacturerID>
<ModelID>7</ModelID>
<OnOrder>true</OnOrder>
<OrderID>1</OrderID>
<OrderReason>1</OrderReason>
<PartCode>sample string 13</PartCode>
<PartNumber>sample string 14</PartNumber>
<SerialNumber>sample string 10</SerialNumber>
<Visible>true</Visible>
</ConsumableDTO>
</ArrayOfConsumableDTO>