ezeio2:apiref:status

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
ezeio2:apiref:status [2019-06-16 19:38] andrehezeio2:apiref:status [2024-02-21 19:10] (current) andreh
Line 1: Line 1:
-===== API reference ====== 
- 
 ==== status ==== ==== status ====
  
Line 7: Line 5:
 === Description === === Description ===
  
-<code>https://api.eze.io/v1/status/{serial}/[sections]/[fields]</code>+<code>https://api.eze.io/v1/status/{serial}/[sections=X,Y]/[fields=X,Y]</code>
  
 This will retrieve the most recently reported status of the given controller. Note that the information is taken from the servers most recent status. This message does not generate traffic to the actual controller. Thus, it is normal that this status can be up to 10 minutes old. This will retrieve the most recently reported status of the given controller. Note that the information is taken from the servers most recent status. This message does not generate traffic to the actual controller. Thus, it is normal that this status can be up to 10 minutes old.
Line 14: Line 12:
  
 | ''serial'' | ezeio serial number (XYZ123) | | ''serial'' | ezeio serial number (XYZ123) |
-| ''sections'' (optional) | Limit the reply to certain sections. Default is to receive all available data. |+| ''sections'' (optional) | Limit the reply to certain sections. Default is "meta, adc, out, pos, fields, fieldmeta". |
 | ''fields'' (optional) | Limit the reply to certain fields. Default is to receive all fields. | | ''fields'' (optional) | Limit the reply to certain fields. Default is to receive all fields. |
 +
 +Available sections are:
 +| ''meta'' | ezeio metadata |
 +| ''adc'' | status of on-board inputs |
 +| ''out'' | status of on-board outputs |
 +| ''pos'' | GPS/position data |
 +| ''fields'' | field values |
 +| ''fieldmeta'' | include field metadata with each field record |
 +| ''device'' | device metadata and status |
 +| ''alarms'' | alarm status (if available) |
  
 === Example usage === === Example usage ===
  
-Fetch full status record from serial XYZ123+Fetch default status record from serial XYZ123
 <code>https://api.eze.io/v1/status/XYZ123</code> <code>https://api.eze.io/v1/status/XYZ123</code>
 +
 +Fetch only field values and position from serial XYZ123
 +<code>https://api.eze.io/v1/status/XYZ123/sections=fields,pos</code>
  
 === Return value === === Return value ===
Line 39: Line 50:
     "note":"Here is a note",     "note":"Here is a note",
     "tzofs":"0",     "tzofs":"0",
 +    "link":"Cell",
 +    "RSSI":-87,
     "sim_iccid":"89148000003622803539"     "sim_iccid":"89148000003622803539"
   },   },
  • ezeio2/apiref/status.1560713886.txt.gz
  • Last modified: 2019-06-16 19:38
  • by andreh