GET api/Groups/GetStatus?id={id}&includeUnitSerials={includeUnitSerials}
Returns Additional information about the group
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| id |
the groups Id |
integer32 |
Required |
| includeUnitSerials |
if true, will return the serialnumbers of units comprising each count |
boolean |
Default value is False |
Body Parameters
None.
Response Information
Resource Description
Returns Additional information about the group
StatusGroupModel| Name | Description | Type | Additional information |
|---|---|---|---|
| LowBatteryList | Collection of string |
None. |
|
| ActiveUnitsList | Collection of string |
None. |
|
| NoCommunicationUnitsList | Collection of string |
None. |
|
| ReadyForActivationList | Collection of string |
None. |
|
| NeedsInspectionList | Collection of string |
None. |
|
| HasRecentAlarmUnitsList | Collection of string |
None. |
|
| TotalLowBatteryList | Collection of string |
None. |
|
| TotalActiveUnitsList | Collection of string |
None. |
|
| TotalNoCommunicationUnitsList | Collection of string |
None. |
|
| TotalReadyForActivationList | Collection of string |
None. |
|
| TotalNeedsInspectionList | Collection of string |
None. |
|
| TotalHasRecentAlarmUnitsList | Collection of string |
None. |
|
| UnitsCount |
Number of Units in the group |
integer32 |
None. |
| Units |
Units in the group |
Collection of string |
Null values possible. |
| AllUnits |
Units in the group and Child Groups |
Collection of string |
None. |
| TotalUnitsCount |
Number of Units in the group and Child Groups |
integer32 |
None. |
| TotalSuspendedUnitsCount |
Number of suspended Units in the group and Child Groups Suspended units are not counted in any of the other available metrics, regardless of actual status |
integer32 |
None. |
| SuspendedUnitsCount |
Number of suspended Units in the group Suspended units are not counted in any of the other available metrics, regardless of actual status |
integer32 |
None. |
| LowBatteryCount |
Number of Units with estimated Battery less than 15% |
integer32 |
None. |
| TotalLowBatteryCount |
Number of Units with estimated Battery less than 15% (including units in child groups) |
integer32 |
None. |
| ActiveUnitsCount |
Number of Active Units in the group (reported status within last 6 days) |
integer32 |
None. |
| TotalActiveUnitsCount |
Number of Active Units in the group (reported status within last 6 days) (including units in child groups) |
integer32 |
None. |
| RecentAlarmsCount |
Total number of alarms from units last 24h |
integer32 |
None. |
| HasRecentAlarmsUnitCount |
Number of units that has at least one alarm last 24h |
integer32 |
None. |
| TotalHasRecentAlarmsUnitCount |
Number of units that has at least one alarm last 24h (including units in child groups) |
integer32 |
None. |
| TotalRecentAlarmsCount |
Total number of alarms from units last 24h (including units in child groups) |
integer32 |
None. |
| NeedsInspectionCount |
Number of Units with NextInspectionDate exceeded |
integer32 |
None. |
| TotalNeedsInspectionCount |
Number of Units with NextInspectionDate exceeded (including units in child groups) |
integer32 |
None. |
| NoCommunicationUnitsCount |
Number of NoCommunication units in the group (missed 5 or more consecutive reports and at least 5 days since last communication) |
integer32 |
None. |
| TotalNoCommunicationUnitsCount |
Number of NoCommunication units in the group (missed 5 or more consecutive reports and at least 5 days since last communication) (including units in child groups) |
integer32 |
None. |
| ReadyForActivationUnitsCount |
Number of Units that can be activated in the group (new units that have not yet been activated by magnet or otherwise) |
integer32 |
None. |
| TotalReadyForActivationUnitsCount |
Number of Units that can be activated in the group (new units that have not yet been activated by magnet or otherwise) (including units in child groups) |
integer32 |
None. |
| Id |
Id of the group |
integer32 |
None. |
| Name |
Name of the group |
string |
None. |
| ParentId |
the Id of this groups parent |
integer32 |
None. |
Response Formats
application/json, text/json
Sample not available.