WattDepot logo WattDepot3 HTTP API: Collector Metadata

GET /wattdepot/{group_id}/collectormetadatas

http://server.wattdepot.org/wattdepot/{group_id}/collectormetadatas Response
		      
[
   {
      "id": "egauge1-fast",
      "sensor": 
            {
               "id": "ilima-6-telco",
               "uri": "http://foo.com/ilima-6-telco",
               "location":
                     {
                        "description": "Hale Aloha Ilima residence hall 6th floor",
                        "altitude": 30,
                        "longitude": -157.812727,
                        "latitude": 21.294642,
                        "id": "ilima-6th"
                     },
               "model":
                     {
                        "id": "egauge1.0",
                        "protocol": "eGauge",
                        "type": "EGAUGE",
                        "version": "1.0"
                     },
               []
            },
      "pollingInterval": 10
   },
   {
      "id": "shark1-slow",
      "sensor": 
            {
               "id": "ilima-6-elect",
               "uri": "http://foo.com/ilima-6-elect",
               "location":
                     {
                        "description": "Hale Aloha Ilima residence hall 6th floor",
                        "altitude": 30,
                        "longitude": -157.812727,
                        "latitude": 21.294642,
                        "id": "ilima-6th"
                     },
               "model":
                     {
                        "id": "shark1",
                        "protocol": "MODBUS",
                        "type": "Shark 200",
                        "version": "1.03"
                     },
               []
            },
      "pollingInterval": 3600
   }
]
		      
		    

Get a full list of defined Collector Metadata.

GET /wattdepot/{group_id}/collectormetadata/{collectormetadata_id}

http://server.wattdepot.org/wattdepot/{group_id}/collectormetadata/egauge1-fast Response
              
{
   "id": "egauge1-fast",
   "sensor": 
         {
            "id": "ilima-6-telco",
            "uri": "http://foo.com/ilima-6-telco",
            "location":
                  {
                     "description": "Hale Aloha Ilima residence hall 6th floor",
                     "altitude": 30,
                     "longitude": -157.812727,
                     "latitude": 21.294642,
                     "id": "ilima-6th"
                  },
            "model":
                  {
                     "id": "egauge1.0",
                     "protocol": "eGauge",
                     "type": "EGAUGE",
                     "version": "1.0"
                  },
            []
         },
   "pollingInterval": 10
}
              
            

Get the Collector Metadata with the given collectormetadata_id.

PUT /wattdepot/{group_id}/collectormetadata/

curl -F '{id :"egauge1-fast", "sensor": {id: "sensor1", uri: "http://foo.com", location: {id :"loc2", "latitude": 21.294642, "longitude": -157.812727, "altitude": 40.0, "description": "40.0"}, model: {id :"egauge1", "protocol": "eGauge", "type": "EGAUGE", "version": "1.0"}, []}, "pollingInterval": 10}' http://server.wattdepot.org/wattdepot/{group_id}/collectormetadata/
              
{
   "status": 200,
   "message": "OK"
}
              
            

Add the Collector Metadata. Will return the status. Error status if duplicate unique id.

DEL /wattdepot/{group_id}/collectormetadata/{collectormetadata_id}

curl -X DELETE http://server.wattdepot.org/wattdepot/{group_id}/collectormetadata/egauge1.0
              
{
   "status": 200,
   "message": "OK"
}
              
            

Deletes the Collector Metadata with the given collectormetadata_id. Will return the status. Error status if collectormetadata_id is not defined.