eDrive  Help & Support Center

Search:
Contents
Display Legacy Contents

IndexBookmarkPrint
Home > eDrive Web Services > Web Services Reference
Web Services Reference
eDrive will respond to HTTP Web Service requests that are sent to it for processing, provided they meet the meet the format and content described here.  The requests also need to conform to the Port and Authentication properties described in the Setting Operating Parameters section of this document.

General Web Service Request Structure:

      <eDrive URL>/<service><.extension>?<options>  where:  
             <service> : - see List of Available Services, below
             <.extension>: [.xml, .json, (none)] - response format, xml is default
             <options>: - vary with service requested

Note! : Web Service requests are case-sensitive.

With this family of web services you can easily:
  • Request a list of all Point values in eDrive
  • Request a list of Point values for a single Device
  • Request a list of Point values for a single Point Group (more about Point Groups)
  • Request a list of Devices in eDrive
  • Request a list of Point Groups in eDrive
  • Request the stored values of any Points that have History recording enabled

          List of Available Services  (Examples shown assume that eDrive is on PC at IP Address 192.168.100.2 and Port 8082)
points Returns list of all eDrive points grouped by device
                     If points have a '/' in their name, this will form a directory structure that is
                     reflected in the results as additional sub-groupings.

                     !-- Point Services Options:
                          structure=[flat | table | tree] - options for format of response, default=tree
                          properties=<property name(s)> - comma separated list

Example: http://192.168.100.2:8082/points
       Response (XML):
           <root>
             <Main_Electric_Meter name="Main Electric Meter">
                 <Line_to_LineVoltage>213.65</Line_to_LineVoltage>
                 <Total_Bldg_Power_kW>16821</Total_Bldg_Power_kW>
              </Main_Electric_Meter>
             <Sub_Meter_P1 name="Sub Meter P1">
                 <Line_to_LineVoltage>212.91</Line_to_LineVoltage>
                 <Total_Meter_Power_kW>845.2</Total_Meter_Power_kW>
              </Sub_Meter_P1>
           </root>

points/<path> Returns list of all eDrive points in the specified path.  The path may specify a device, or an individual point.

                     !-- Point Services Options:
                          structure=[flat | table | tree] - options for format of response, default=tree
                          properties=<property name(s)> - comma separated list

Example: http://192.168.100.2:8082/points/Main Electric Meter.json
       Response (JSON):
          {
             "Line_to_LineVoltage":"214.7",
             "Total_Bldg_Power_kW":"14981"
          }


Example: http://192.168.100.2:8082/points/Main Electric Meter.json?properties=value,reliable&structure=flat
       Response (JSON):
         {
           "Line_to_LineVoltage.value":"212.78",
           "Line_to_LineVoltage.reliable":true,
           "Total_Bldg_Power_kW.value":"16725",
           "Total_Bldg_Power_kW.reliable":true
         }
points/<path>/<property name> Returns value of specified point property.   The path must specify exactly one point.

                     !-- Point Services Options:
                          structure=[flat | table | tree] - options for format of response, default=tree
                          properties=<property name(s)> - comma separated list

Example: http://192.168.100.2:8082/points/Main Electric Meter/Total_Bldg_Power_kW/reliable.xml
       Response (XML):
        <root type="boolean">true</root>
points/<path>/history Returns history of the specified point.  The path must specifiy exactly one point.

         !-- Point History Services Options:
              structure=[table | objects] - options for format of response
              start=<timestamp> - begin time - format: yyyy-mm-ddThh:mm:ss:SSS-0400 (where -0400 is the timezone offset)
              end=<timestamp> - end time

Example: http://192.168.100.2:8082/points/Continuum NetController 7899/RTU3/SpaceTemp/history.json
       Response (JSON):
            {
              "header":["value", "reliable", "enabled", "alarmState", "commandPriority", "timestamp"],
              "data":[
                ["78.23", true, true, 0, 0, "2017-10-16T12:56:40.324-0400"],
                ["77.76", true, true, 0, 0, "2017-10-16T12:57:40.322-0400"],
                ["78.44", true, true, 0, 0, "2017-10-16T12:58:40.323-0400"],
                ["77.71", true, true, 0, 0, "2017-10-16T12:59:40.322-0400"],
                ["78.12", true, true, 0, 0, "2017-10-16T13:00:40.314-0400"],
                ["78.70", true, true, 0, 0, "2017-10-16T13:01:40.332-0400"]
              ]
            }  
point-list Returns a flat list of all points in eDrive.

Example: http://192.168.100.2:8082/point-list
       Response (XML):
           <root type="array">
              <item0>First Floor Group</item0>
              <item1>Kitchen Group</item1>
          </root>

<path to point-list>


 Returns list of points in the specified eDrive device or point group.

Example: http://192.168.100.2:8082/point-list/Kitchen Group.xml
       Response (XML):
      <root>
      <SpaceTemp>71.84</SpaceTemp>
      <Bulk_Cooler_Temperature name="Bulk Cooler Temperature">44.8125</Bulk_Cooler_Temperature>
      <Bulk_Freezer_Temperature name="Bulk Freezer Temperature">40.875</Bulk_Freezer_Temperature>
      <DmprPosition>25.555557</DmprPosition>
      </root>
devices Returns a list of current eDrive Devices.

Example:   http://192.168.100.2:8082/devices.json
       Response (JSON):
           [
              "Weather Web Service",
              "Main Electric Meter",
              "Weather Underground -Yesterday",
              "AHU_11 - Surgical Unit AHU",
              "Continuum NetController CX",
              "Calculated Points",
              "Siemens Apogee",
              "FAS Office SBO"
            ]
devices/<name of device> Returns eDrive properties of the specified Device.

Example: http://192.168.100.2:8082/devices/Weather Web Service
       Response (XML):
            <root>
                <name>Weather Web Service</name>
                <description>Weather Web Service</description>
                <pointCount type="number">7</pointCount>
                <pollerType>WebService</pollerType>
                <pollTimeout type="number">2000</pollTimeout>
                <reliable type="boolean">true</reliable>
                <interval type="number">30000</interval>
                <actualInterval type="number">30000</actualInterval>
                <totalPollTime type="number">30000</totalPollTime>
                <averagePointReliability type="number">1.0</averagePointReliability>
                <lastPollTimestamp>2017-10-16T11:21:25.624-0400</lastPollTimestamp>
            </root>


Next: Creating Point Groups