Schedule Demand Response (DR) for all Facilities

Schedules a Demand Response (DR) for all facilities for a specific period from the start time.

Request

POST https://{em_ip_address_or_hostname}/ems/api/org/dr/scheduledr

{
    "pricelevel": "LOW",
    "duration": "60",
    "starttime": "2015-07-21T12:15:49+05:30",
    "dridentifier": "DR16",
    "pricing": "15.0"
 }

Parameters

Request 
em_ip_address or hostname The Enlighted Manage (EM) IP address or hostname
Body 
pricelevel

DR pricing:

HIGH
MODERATE
LOW
SPECIAL

duration The DR duration time in minutes (must be a whole number)
starttime Time from when DR should be in effect.
Format: (yyyyMMddHHmm) year/month/day/hour/minutes
dridentifier User assigned Demand Response (DR) identifier
pricing DR pricing that is effective for the energy consumed during the DR period (optional)
Response 
status 0 – DR schedule successful
1 – DR not scheduled
msg Message description

Sample Code

Schedule a Demand Response (DR) at LOW price level for all facilities for 60 minutes starting at 5:30 am on 07-21-2015 at 15 cents. The response indicates that the DR schedule was successful.

If the user is accessing web service with proper session/authenticated token:
POST https://192.80.3.2/ems/api/org/dr/scheduledr
{
    "pricelevel": "LOW",
    "duration": "60",
    "starttime": "2015-07-21T12:15:49+05:30",
    "dridentifier": "DR16",
    "pricing": "15.0"
 }

Response:
HTTP/1.1 200: OK
  {
    "status": "0",
    "msg": "DR Scheduled successful"
  }
 
If the user is accessing web service without creating session:
HTTP/1.1 302: Moved Temporarily

Schedule Demand Response (DR) for Selected Facilities

Schedules a Demand Response (DR) for a list of selected facilities in the organization for a specific period from the start time.

Request

POST https://{em_ip_address_or_hostname}/ems/api/org/dr/scheduledr/facilities/{facility specification list}

{
    "pricelevel": "LOW",
    "duration": "60",
    "starttime": "2015-07-21T12:15:49+05:30",
    "dridentifier": "DR16",
    "pricing": "15.0"
 }

Parameters

Request 
em_ip_address or hostname The Enlighted Manage (EM) IP address or hostname
facility specification list

Schedules a demand response for a list of selected facilities. List of facilities separated by commas. Each facility contains facility type and facility ID: {facility type}_{facility ID} Facility Type: Can be either a company, campus, building, or floor. Facility ID: A unique identifier that is assigned to the company or organization, campus, building or floor. (Facility ID is returned in Get All Floors API).

Note: Specifying a facility other than the floor automatically assigns DR to all floors under the facility. Assigning a campus will assign DR to all floors for all buildings on the campus. 

For example,

1. To assign DR to the first and second floors of a building, type floor_1,floor_2. DR will be assigned to floor 1 and floor 2.
2.  To assign DR to all floors in the Headquarters Building with ID 22, type Building_22. DR will be assigned to all floors in building 22.

Body
pricelevel

DR pricing:
HIGH
MODERATE
LOW
SPECIAL

duration The DR duration time in minutes (must be a whole number)
starttime Time from when DR should be in effect.
Format: (yyyyMMddHHmm) year/month/day/hour/minutes 
dridentifier User assigned DR identifier
pricing DR pricing that is effective for the energy consumed during the DR period (optional)
Response 
status

0 – DR schedule successful
1 – DR not scheduled

msg Message description

Sample Code

For example, schedule a Demand Response (DR) at LOW price level for Floor 1 in Building 51, Campus 1, for 60 minutes starting at 5:30 am on 07-21-2015 at 15 cents. The response indicates that the DR schedule was successful.

If the user is accessing web service with proper session/authenticated token:
POST https://192.80.30.2/ems/api/org/dr/scheduledr/facilities/floor_1,building_51,campus_1
{
    "pricelevel": "LOW",
    "duration": "60",
    "starttime": "2015-07-21T12:15:49+05:30",
    "dridentifier": "DR16",
    "pricing": "15.0"
 }
HTTP/1.1 200: OK
  {
    "status": "0",
    "msg": "DR Scheduled successful"
  }

Update Demand Response for all Facilities

Update the current running or scheduled Demand Response (DR) for all facilities.

Request

POST https://{em_ip_address_or_hostname}/ems/api/org/dr/updatedr

{
    "pricelevel": "LOW",
    "duration": "60",
    "starttime": "2015-07-21T12:15:49+05:30",
    "dridentifier": "DR16",
    "pricing": "15.0"
 }

Parameters

Request 
em_ip_addressor hostname: The Enlighted Manage (EM) IP Address or hostname
Body
pricelevel:

DR pricing:
HIGH
MODERATE
LOW
SPECIAL

duration: The DR duration time in minutes (must be a whole number)
starttime: Time from when DR should be in effect.
Format: (yyyyMMddHHmm) year/month/day/hour/minutes, for example,
2015-11-18T17:43:00
dridentifier: DR identifier provided at the time of scheduling
pricing: DR pricing that is effective for the energy consumed during the DR period (optional).
Response 
status: 0 – DR schedule successful.
1 – DR not scheduled.
msg: Message description.

Sample Code

Update the currently running Demand Response (DR) from LOW to HIGH price level for all facilities for 60 minutes starting at 5:30 am on 07-21-2015 at 15 cents. The response indicates that the DR update was successful.

If the user is accessing web service with proper session/authenticated token:
POST https://{192.80.30.2}/ems/api/org/dr/updatedr
{
"pricelevel": "HIGH",
"duration": "60",
"starttime": "2015-07-21T12:15:49+05:30",
"dridentifier": "DR16",
"pricing": "15.0"
}

HTTP/1.1 200: OK
{
    "status": "0",
    "msg": "DR updated successfully"
}

 

Update Demand Response for Selected Facilities

Update the current running or scheduled Demand Response for a list of selected facilities in the organization for a specific period from the start time.

Request

POST https://{em_ip_address_or_hostname}/ems/api/org/dr/updatedr/facilities/{facility specification list}

{
    "pricelevel": "LOW",
    "duration": "60",
    "starttime": "2015-07-21T12:15:49+05:30",
    "dridentifier": "DR16",
    "pricing": "15.0"
 }

Parameters

Request 
em_ip_address or hostname: The Enlighted Manage (EM) IP address or hostname.
facility specification list:

Schedules a demand response for selected facilities. List of facilities separated by commas. Each facility contains facility type and facility ID: {facility type} {facility ID}

Facility Type: Can be either a company, campus, building, or floor.

Facility ID: A unique identifier that is assigned to the company or organization, campus, building or floor. (Facility ID is returned in Get All Floors API).

Note: Specifying a facility other than the floor automatically assigns DR to all floors under the facility. Assigning a campus will assign DR to all floors for all buildings in the campus. For example,

  1. To assign DR to the first and second floors of a building, type floor_1,floor_2. DR will be assigned to floor 1 and floor 2.
  2. To assign DR to all floors in the Headquarters Building with ID 22, type Building_22. DR will be assigned to all floors in building 22.
Body
pricelevel:

DR pricing:
HIGH
MODERATE
LOW
SPECIAL

duration: The DR duration time in minutes (must be a whole number)
starttime: Time from when DR should be in effect.Format: (yyyyMMddHHmm) year/month/day/hour/minutes,
for example, 2015-11-18T17:43:00
dridentifier: DR identifier provided at the time of scheduling.
pricing: DR pricing that is effective for the energy consumed during the DR period (optional).
Response 
status: 0 – DR schedule successful.
1 – DR not scheduled.
msg: Message description.

Sample Code

For example, update the currently running Demand Response (DR) event from LOW to HIGH price level for Floor 1 in Building 51, Campus 1, for 60 minutes starting at 5:30 am on 07-21-2015 at 15 cents. The response indicates that the DR update was successful.

If user is accessing web service with proper session/authenticated token:
https://192.80.30.2/ems/api/org/dr/updatedr/facilities/floor_1,building_51,campus_1

{

"pricelevel": "HIGH",
"duration": "60",
"starttime": "2015-07-21T12:15:49+05:30",
"dridentifier": "DR16",
"pricing": "15.0"
}

HTTP/1.1 200: OK
{
    "status": "0",
    "msg": "DR updated successfully"
}

 

List Demand Response

Obtains a list of all running and scheduled DRs.

Request

GET https://{em_ip_address_or_hostname}/ems/api/org/dr/listdr

Parameters

Request 
em_ip_address or hostname: The Enlighted Manage (EM) IP address or hostname.
Response 
Displays a list of current or scheduled target Demand Responses for the organization.

Sample Code

Display list of all running and scheduled DRs.

If the user is accessing web service with proper session/authenticated token:
GET https://93.2.8.1/ems/api/org/dr/listdr

HTTP/1.1 200: OK
{
  "dRTargets": {
    "drTarget": {
      "id": "39",
      "pricelevel": "LOW",
      "pricing": "15.0",
      "duration": "3600",
      "targetreduction": "10",
      "starttime": "2015-07-21T13:15:49+05:30",
      "dridentifier": "DR18",
      "drstatus": "Active",
      "drtype": "MANUAL",
      "option": "true",
      "jitter": "0"
    }
  }
}

Cancel Demand Response

Cancels the currently running Demand Response (DR) or a scheduled DR.

Request

POST https://{em_ip_address_or_hostname}/ems/api/org/dr/canceldr

   {
       "dridentifier": "DR16",
    }

Parameters

Request 
em_ip_address or hostname: The Enlighted Manage (EM) IP address or hostname.
Body 
dridentifier: DR Identifier provided at the time of scheduling.
Response 
status: 0 – DR cancelled successfully.
1 – DR not cancelled.
msg: Status message description.

Sample Code

Cancel the scheduled Demand Response (DR) event using the DR identifier. The response indicates that the DR canceled successfully.

    If the user is accessing web service with proper session/authenticated token:
    POST-https://192.80.30.2/ems/api/org/dr/canceldr

   {
       "dridentifier": "DR16",
   }

    HTTP/1.1 200: OK
   {
          "status": "0",
         "msg": "DR Cancelled successfully"
   }