Override Fixture Light Level Settings

Now, that you are familiar with the APIs, here is a sample scenario you will likely perform when managing lights in your building.

Consider you have an AV touchscreen, and you would like to override fixture light settings for the switch on a floor.  To use the override API, you will need to know the Switch name and Floor ID of the floor in the building. Note that all API calls are secure HTTPS calls and should be made with the associated username and specific APIkey. Here are the steps that you will need to perform.

  1. Authenticate with username and password. See User Authentication.
  2. Determine the Floor ID. Use the Get All Floors API to obtain the list of floors in the building for the organization.
  3. Next, determine the switch name that was programmed in the Enlighted Manage (EM). In EM, select Facility > Floor in the left panel, click the Floor Plan tab to view the floor plan. Hover the cursor on the switch to obtain the switch name. You can also use the Get Switch Groups API to obtain the Switch name, but note that this command will list all switch names on the floor.   
  4. Then, Using the Floor ID returned by the Get All Floors API and Switch name, override the fixture profile settings controlled by the switch to dim the fixtures for a period of time using the Manual Override for Switch Group API.

Sample Code

  **Obtain floor-id**

  Get https://{192.80.3.2}/ems/api/org/floor/list

  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


  {
    "floor": [
     {
        "id": "1",
        "name": "First Floor",
        "building": "1",
        "campus": "1",
        "company": "1",
        "description": "Sales and Marketing",
        "floorPlanUrl": "entire 930 floor plan.jpg"
     },
     {
        "id": "2",
        "name": "Second Floor",
        "building": "1",
        "campus": "1",
        "company": "1",
        "description": "Product",
        "floorPlanUrl": "entire 930 floor plan.jpg"
     }
   ]
 }
  ** Manually override the switch settings using the Floor ID and Switch name**

  Post https://192.80.3.2/ems/api/org/switch/v1/op
  /dimGroup/1/SwitchGrp1/10?time=60


  HTTP/1.1 200 OK
  Server: Apache-Coyote/1.1
  Content-Type: application/json
  Content-Length: 7582
  Date: Sat, 21 Jul 2015 17:06:51 GMT

  {
    "status": "0"
  } 

  **Overrides the Switch settings and lowers the
  fixture light level to 10% for one hour. **