GET OneStop/Groups/{GroupID}/Devices/{DeviceID}

Gets 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

DeviceDTO

Name	Description	Type	Additional information
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

Sample:

{
  "DeviceID": 1,
  "IPAddress": "sample string 2",
  "MacAddress": "sample string 3",
  "Description": "sample string 4",
  "SerialNumber": "sample string 5",
  "Location": "sample string 6",
  "Manufacturer": "sample string 7",
  "Model": "sample string 8",
  "ModelID": 9,
  "GroupID": 1,
  "Monitored": true,
  "ScanGroupID": 1,
  "DateAdded": "2026-07-07T14:50:16.3673672+01:00",
  "Survey": 1,
  "SurveyExpire": "2026-07-07T14:50:16.3673672+01:00",
  "IsColour": true,
  "Device_CustomField_1": "sample string 11",
  "Device_CustomField_2": "sample string 12",
  "SortIPAddress": "sample string 13",
  "ContactID": 14,
  "UseTonerDescription": true,
  "Local": true,
  "AssetNumber": "sample string 17",
  "DeviceMovedScanGroupFlag": true,
  "NewDeviceFlag": true,
  "NewConsumableOrderFlag": true,
  "NewAlertFlag": true,
  "Comments": "sample string 22",
  "ValidateConsumableChange": 23,
  "HasError": true,
  "HasWarning": true,
  "HasOther": true,
  "HasMaintenance": true,
  "LastCommunication": "2026-07-07T14:50:16.3673672+01:00",
  "MarkerTech": 28,
  "DeviceType": 29,
  "Name": "sample string 30",
  "HostName": "sample string 31",
  "Status": 32,
  "ManufacturerID": 33,
  "FullName": "sample string 34",
  "Address1": "sample string 35",
  "Address2": "sample string 36",
  "Address3": "sample string 37",
  "PostCode": "sample string 38",
  "Phone": "sample string 39",
  "GroupPath": "sample string 40",
  "FullPath": "sample string 41",
  "AddressID": 42,
  "AddressLine1": "sample string 43",
  "AddressLine2": "sample string 44",
  "AddressLine3": "sample string 45",
  "AddressLine4": "sample string 46",
  "Town": "sample string 47",
  "County": "sample string 48",
  "Country": "sample string 49",
  "DeviceTotal": 1,
  "TotalMono": 1,
  "TotalColour": 1,
  "FirmwareVersion": "sample string 50"
}

application/xml, text/xml

Sample:

<DeviceDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneStopWebAPI.DTO">
  <Address1>sample string 35</Address1>
  <Address2>sample string 36</Address2>
  <Address3>sample string 37</Address3>
  <AddressID>42</AddressID>
  <AddressLine1>sample string 43</AddressLine1>
  <AddressLine2>sample string 44</AddressLine2>
  <AddressLine3>sample string 45</AddressLine3>
  <AddressLine4>sample string 46</AddressLine4>
  <AssetNumber>sample string 17</AssetNumber>
  <Comments>sample string 22</Comments>
  <ContactID>14</ContactID>
  <Country>sample string 49</Country>
  <County>sample string 48</County>
  <DateAdded>2026-07-07T14:50:16.3673672+01:00</DateAdded>
  <Description>sample string 4</Description>
  <DeviceID>1</DeviceID>
  <DeviceMovedScanGroupFlag>true</DeviceMovedScanGroupFlag>
  <DeviceTotal>1</DeviceTotal>
  <DeviceType>29</DeviceType>
  <Device_CustomField_1>sample string 11</Device_CustomField_1>
  <Device_CustomField_2>sample string 12</Device_CustomField_2>
  <FirmwareVersion>sample string 50</FirmwareVersion>
  <FullName>sample string 34</FullName>
  <FullPath>sample string 41</FullPath>
  <GroupID>1</GroupID>
  <GroupPath>sample string 40</GroupPath>
  <HasError>true</HasError>
  <HasMaintenance>true</HasMaintenance>
  <HasOther>true</HasOther>
  <HasWarning>true</HasWarning>
  <HostName>sample string 31</HostName>
  <IPAddress>sample string 2</IPAddress>
  <IsColour>true</IsColour>
  <LastCommunication>2026-07-07T14:50:16.3673672+01:00</LastCommunication>
  <Local>true</Local>
  <Location>sample string 6</Location>
  <MacAddress>sample string 3</MacAddress>
  <Manufacturer>sample string 7</Manufacturer>
  <ManufacturerID>33</ManufacturerID>
  <MarkerTech>28</MarkerTech>
  <Model>sample string 8</Model>
  <ModelID>9</ModelID>
  <Monitored>true</Monitored>
  <Name>sample string 30</Name>
  <NewAlertFlag>true</NewAlertFlag>
  <NewConsumableOrderFlag>true</NewConsumableOrderFlag>
  <NewDeviceFlag>true</NewDeviceFlag>
  <Phone>sample string 39</Phone>
  <PostCode>sample string 38</PostCode>
  <ScanGroupID>1</ScanGroupID>
  <SerialNumber>sample string 5</SerialNumber>
  <SortIPAddress>sample string 13</SortIPAddress>
  <Status>32</Status>
  <Survey>1</Survey>
  <SurveyExpire>2026-07-07T14:50:16.3673672+01:00</SurveyExpire>
  <TotalColour>1</TotalColour>
  <TotalMono>1</TotalMono>
  <Town>sample string 47</Town>
  <UseTonerDescription>true</UseTonerDescription>
  <ValidateConsumableChange>23</ValidateConsumableChange>
</DeviceDTO>