Get Sensor Profiles

July 12, 2022 18:38 Updated

The API returns the existing and applicable profiles that can be assigned to the sensor. The list of applicable profiles displayed is derived from the profile template as the existing profile. The profile group ID returned is used as the primary identifier in other API calls.

Request

GET https:/{em_ip_address_or_hostname}/ems/api/org/fixture/v1/getFixtureApplicableProfiles/{fixture_id}

Parameters

Request
em_ip_address or hostname	The Enlighted Manage (EM) IP address or hostname
fixture_id	Fixture or sensor identifier. Use the Fixture ID returned by the Get Sensor Details by Floor API or in EM, select Facility > Floor in the left panel, Floor Plan tab, and double-click the fixture icon in the floor plan to obtain the Fixture ID.
Response
id	The fixture or sensor identifier
name	Sensor name. For example, Sensorxxxxxx
currentProfile	Displays the name of the existing profile assigned to the sensor.
groupId**	Profile group identifier. The ID of the profile associated with the fixture. (**used as the primary identifier in other API calls)
applicableProfiles	Lists profiles derived from the same profile template as the current profile.

Sample Code

Using the Fixture ID returned by the Get Sensor Details by Floor API, request the profile name assigned to the sensor. As shown in the response below, Open Office Max 35 is the profile assigned to fixture with ID ‘28’. In addition to the profile assigned to the fixture, the API also returns the list of applicable profiles and the corresponding profile Group ID derived from Open Office Max 35. The Group ID is used as the primary identifier in other API calls.

Get https:/192.80.3.2/ems/api/org/fixture/v1/getFixtureApplicableProfiles/28

HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Content-Type: application/xml
Content-Length: 7582
Date: Sat, 21 Jul 2015 17:06:51 GMT
 {
  "id": "28",                                   **fixture-id**
 "name": "Sensor00ceed",                        **fixture name**
 "currentProfile": "Open Office Max 35",        **profile name**
 “groupId”: “27”                                **groupID**
 "applicableProfiles":                          **list of applicable profiles** 
 [
 {
 "name": "Open Office Max 35",
 "groupId": "27"
 },
 {
 "name": "Open Office Max 70",
 "groupId": "28"
 },
 {
 "name": "Open Office Max 50",
 "groupId": "29"
 },
 {
 "name": "default.Open Office_Normal",
 "groupId": "46"
 },
 {
 "name": "default.Open Office_AlwaysOn",
 "groupId": "47"
 },
 {
 "name": "default.Open Office_Dim",
 "groupId": "48"
 }
 ]
}

Articles in this section

Request

Parameters

Sample Code

Related articles

Comments