Get Switch Groups¶
Switch Groups control turning on or off a group of fixtures. This API returns all Switch Groups on a floor in the building. The response includes the Switch Group ID and Switch Name for each Switch Group.
The Switch Name and ID are used as the primary identifiers in other API calls.
Request¶
GET https://{em_ip_address_or_hostname}/ems/api/org/switchgroups/list/{facility}/{floor_id}
Parameters¶
| Name | Description |
|---|---|
| Request | |
| em_ip_address_or_hostname | Manage’s IP address or hostname |
| facility | The facility type can be either a floor or a company. |
| floor_id | Floor identifier. Use the Get All Floors API, or in EM, select Facility > Floor > in the left panel, and click the Settings tab to obtain the Floor ID. |
| Response | |
| id | Switch Group identifier in Enlighted Manage |
| name | Switch Name (**used as the primary identifier in other API calls) |
Sample Request¶
Users can request the list of all Switch Groups on a floor using the Floor ID. The API lists the Switch Group ID, and the Switch name for all Switch Groups.
For example, if Floor 1 has two Switch Groups, the API returns the Switch Group ID and Switch Name for both Switch Groups. The Switch Name is used as the primary identifier in other API calls.
GET https://191.18.0.1/ems/api/org/switchgroups/list/floor/1
Sample Response¶
"gemsGroup":[
{
"id": 7,
"name": "594_SWG"
},
{
"id": 8,
"name": "595_SWG"
}
]