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 [2024-02-21 18:22] andrehezeio2:apiref:status [2024-02-21 19:10] (current) andreh
Line 5: 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 23: Line 23:
 | ''fieldmeta'' | include field metadata with each field record | | ''fieldmeta'' | include field metadata with each field record |
 | ''device'' | device metadata and status | | ''device'' | device metadata and status |
 +| ''alarms'' | alarm status (if available) |
  
 === Example usage === === Example usage ===
Line 28: Line 29:
 Fetch default 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 ===
  • ezeio2/apiref/status.1708539746.txt.gz
  • Last modified: 2024-02-21 18:22
  • by andreh