IPDevice
Get a list of IP devices.
Resource URL
GET: https://<ServerIP>/unifiedgui/webapi/IPDevices
Example Request with Filter
GET: https://<ServerIP>/unifiedgui/webapi/IPDevices?$filter=Manufacturer eq 'Company'
Example Response
{
"value":[
{
"Id": "5675xxx-41c8-e451-8044-0050343418f4",
"MAC": "00:02:f1:8a:07:x4",
"IPAddress": "192.168.11.55",
"Type": "IPDevice",
"Manufacturer": "AtlasIED",
"APIVersion": "1.1",
"Model": "IP-SDMF",
"Description": "AtlasIED IPX",
"FirmwareVersion": "1.2.0",
"IsRegistered": true
},
{
"Id": "fb1a6ree-41c8-e911-85ea-0050458f18f4",
"MAC": "00:20:f7:00:ab:f9",
"IPAddress": "192.168.10.20",
"Type": "IPSpeaker",
"Manufacturer": "Company",
"APIVersion": null,
"Model": "Ceiling Speaker v2",
"Description": null,
"FirmwareVersion": "v6.2.2",
"IsRegistered": true
},...
]}
Example Get IPDevice Request with Id
GET: http://<ServerIP>/unifiedgui/webapi/IPDevices(5675aed6-41c8-e911-80ea-0050568f18f4)?
{
"@odata.context": "http://localhost/unifiedgui/webapi/$metadata#IPDevices/$entity",
"@odata.type": "#dotnetmvc.Models.ApiModel.IPDeviceDetail",
"Id": "5675aed6-41c8-e911-80ea-0050568f18f4",
"MAC": "00:02:c1:8a:07:a4",
"IPAddress": "192.168.19.55",
"Type": "IPDevice",
"Manufacturer": "AtlasIED",
"APIVersion": "1.1",
"Model": "IP-SDMF",
"Description": "AtlasIED IPX",
"FirmwareVersion": "1.2.0",
"IsRegistered": true,
"Serial": null,
"CommandPort": 8082,
"Protocol": "TCP",
"AudioInputs": 1,
"AudioOutputs": 1,
"GPInputs": 2,
"GPOutputs": 1,
"HeartbeatDateTime": "2020-08-06T22:26:01.399445Z",
"RegisteredDateTime": "2020-08-06T22:26:01.399445Z",
"SupportsMulticastRelay": false,
"SupportsStoredAudio": false,
"SupportXMLCommands": true,
"SupportText": true,
"SupportVideo": false,
"MulticastSubnets": "",
"SupportImage": false
}
Delete an IPDevice
DELETE: http://<ServerIP>/unifiedgui/webapi/IPDevices(4c77dd9c-417c-4ae4-a3c1-91a692efb11e)
If the delete is successful, a 204 No Content response is returned.