GET OneStop/Groups/{GroupID}/DeviceInfoForApp?IncludeSubGroups={IncludeSubGroups}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| GroupID | integer |
Required |
|
| IncludeSubGroups | boolean |
Default value is True |
Body Parameters
None.
Response Information
Resource Description
Collection of DeviceInfoDTO| Name | Description | Type | Additional information |
|---|---|---|---|
| Consumables | Collection of ConsumableDTO |
None. |
|
| Errors | Collection of DeviceAlertDTO |
None. |
|
| Warnings | Collection of DeviceAlertDTO |
None. |
|
| FullPathName | string |
None. |
|
| DeviceID |
Auto generated |
integer |
Read Only |
| IPAddress |
IP Address of device |
string |
Read Only |
| MacAddress |
MAC Address of device in the format AA:AA:AA:AA:AA:AA |
string |
Read Only |
| Description |
Device Description OID 1.3.6.1.2.1.25.3.2.1.3 |
string |
Read Only |
| SerialNumber |
Device Serial Number |
string |
None. |
| Location |
Device location. Retrieved from OID 1.3.6.1.2.1.1.6 |
string |
None. |
| Manufacturer |
Device manufacturer |
string |
Read Only |
| Model |
Device model name |
string |
Read Only |
| ModelID |
Device model ID |
integer |
Read Only |
| GroupID |
Group ID of device |
integer |
Read Only |
| Monitored |
Whether a device is monitored or not |
boolean |
None. |
| ScanGroupID |
Group ID of the agent currently reporting on this device |
integer |
Read Only |
| DateAdded |
Date added to system |
date |
Read Only |
| Survey |
Not on Survey = 0, On Survey = 1, Near End = 2 (10 or less days remaining), Ended = 3, |
integer |
Read Only |
| SurveyExpire |
Date device survey license expires |
date |
Read Only |
| IsColour |
If a device is colour |
boolean |
Read Only |
| Device_CustomField_1 |
Custom data field |
string |
None. |
| Device_CustomField_2 |
Custom data field |
string |
None. |
| SortIPAddress |
IP address in sortable format aaabbbcccddd with leading zeros |
string |
Read Only |
| ContactID |
ID of user that is device primary contact |
integer |
None. |
| UseTonerDescription |
If toner description should be used when processing consumables. Only needs to be set for devices that have multiple similar consumables, such as two black toners |
boolean |
None. |
| Local |
If a device has been picked up the the Local Printer Agent |
boolean |
Read Only |
| AssetNumber |
Device asset number |
string |
None. |
| DeviceMovedScanGroupFlag |
Flag set if device has been detected in a different scan group than currently recorded for device |
boolean |
None. |
| NewDeviceFlag |
Set when device added to system |
boolean |
None. |
| NewConsumableOrderFlag |
Set if a new consumable order has been raised |
boolean |
None. |
| NewAlertFlag |
Set if new alert has been raised |
boolean |
None. |
| Comments |
Option comments about a device |
string |
None. |
| ValidateConsumableChange |
If consumable changes need to be validated by using additional readings |
integer |
None. |
| HasError |
Set if a device has at least one error alert |
boolean |
None. |
| HasWarning |
Set if a device has at least one warning alert |
boolean |
None. |
| HasOther |
Set if a device has at least one other alert |
boolean |
None. |
| HasMaintenance |
Set if a device has at least one maintenance alert |
boolean |
None. |
| LastCommunication |
Last time communication received from device |
date |
Read Only |
| MarkerTech |
Device Marker Tech unknown = 1, LED = 2, Laser = 3, Ink = 4, SolidInk = 5, DotMartix = 6, Wax = 7, Pen = 8, Thermal = 9 |
integer |
Read Only |
| DeviceType |
Device Type unknown = 1, Printer = 2, Plotter = 3, MFD = 4, Fax = 5, Scanner = 6 |
integer |
Read Only |
| Name |
Device name. From OID 1.3.6.1.2.1.43.5.1.1 |
string |
Read Only |
| HostName |
Device host name. Retrieved via DNS lookup, as Host Name is not present in standard MIB |
string |
Read Only |
| Status |
Status of device, based on SNMP alerts clear = 0, Error = 1, Warning = 2, Other = 4, Maintenance = 5 |
integer |
Read Only |
| ManufacturerID |
Manufacturer ID |
integer |
Read Only |
| FullName |
Device Contact Full Name |
string |
None. |
| Address1 |
Address Line 1 |
string |
None. |
| Address2 |
Address Line 2 |
string |
None. |
| Address3 |
Address Line 3 |
string |
None. |
| PostCode |
Postcode |
string |
None. |
| Phone |
Phone number |
string |
None. |
| GroupPath | string |
None. |
|
| FullPath | string |
None. |
|
| AddressID | integer |
None. |
|
| AddressLine1 | string |
None. |
|
| AddressLine2 | string |
None. |
|
| AddressLine3 | string |
None. |
|
| AddressLine4 | string |
None. |
|
| Town | string |
None. |
|
| County | string |
None. |
|
| Country | string |
None. |
|
| DeviceTotal | integer |
Read Only |
|
| TotalMono | integer |
Read Only |
|
| TotalColour | integer |
Read Only |
|
| FirmwareVersion | string |
None. |
Response Formats
application/json, text/json, application/xml, text/xml
Sample not available.