View source for Sensaphone.net API/zone

=[[Sensaphone.net API]]=

==Specifications==
Different zones types may have different configurable properties than others. For example, a '''''2.8k Thermistor F''''' type Zone will have '''''calibration''''', '''''alarm low''''', and '''''alarm high''''' but a '''''Normally Open''''' type zone will not. If a request is made for a property not belonging to a zone type an error will be issued. Below is a chart showing the relations. A property is only available if the type metadata (The '''type_list''' property) has the checked options enabled. Whether or not the above properties correspond with a particular zone type is defined in the meta data for the zone types '''(included in v2 but not v1 of the API)'''. In addition, a property may be disabled at the global scale if it is 'null', regardless of this table. For example, the zone type's meta indicates that it is "External" but the "wireless_zone" field is 'null' on a "read".

'''Type Dependent Properties'''
{{TableStart|border_size=1
}}{{TableRowN|'''Property'''|'''Digital'''|'''Analog'''|'''Internal'''|'''External'''|'''Generic'''|'''Input'''|'''Output'''|'''IP Alarm'''|'''Alarmable'''|'''Table Ranged'''|'''Loggable'''|'''Alarm Low'''|'''Alarm High'''
}}{{TableRowN| wireless_zone|''' '''|''' '''|''' '''|'''&#x2713;'''|''' '''|''' '''|''' '''|''' '''|''' '''|''' '''|''' '''|''' '''|''' '''
}}{{TableRowN| pulse_zone|'''&#x2713;'''|''' '''|''' '''|''' '''|''' '''|''' '''|''' '''|''' '''|''' '''|''' '''|''' '''|''' '''|''' '''
}}{{TableRowN| runtime_zone|'''&#x2713;'''|''' '''|''' '''|''' '''|''' '''|''' '''|''' '''|''' '''|''' '''|''' '''|''' '''|''' '''|''' '''
}}{{TableRowN| output_zone|''' '''|''' '''|''' '''|''' '''|''' '''|''' '''|'''&#x2713;'''|''' '''|''' '''|''' '''|''' '''|'''&#x2713;'''|''' '''
}}{{TableRowN| alarm_zone|''' '''|''' '''|''' '''|''' '''|''' '''|''' '''|''' '''|''' '''|'''&#x2713;'''|''' '''|''' '''|'''&#x2713;'''|''' '''
}}{{TableRowN| table_zone|''' '''|'''&#x2713;'''|''' '''|''' '''|''' '''|''' '''|''' '''|''' '''|''' '''|'''&#x2713;'''|''' '''|''' '''|''' '''
}}{{TableRowN| loggable_zone|''' '''|''' '''|''' '''|''' '''|''' '''|''' '''|''' '''|''' '''|''' '''|''' '''|'''&#x2713;'''|''' '''|''' '''
}}{{TableRowN| alarm_low|''' '''|'''&#x2713;'''|''' '''|''' '''|''' '''|''' '''|''' '''|''' '''|'''&#x2713;'''|''' '''|''' '''|'''&#x2713;'''|''' '''
}}{{TableRowN| alarm_high|''' '''|'''&#x2713;'''|''' '''|''' '''|''' '''|''' '''|''' '''|''' '''|'''&#x2713;'''|''' '''|''' '''|''' '''|'''&#x2713;'''
}}{{TableRowN| modbus_zone|''' '''|''' '''|''' '''|''' '''|'''&#x2713;'''|''' '''|''' '''|''' '''|''' '''|''' '''|''' '''|''' '''|''' '''
}}{{TableEnd}}

===Zone States===
{{TableStart|border_size=1
}}{{TableRowN| '''Zone State'''|'''Value'''    | '''Description'''
}}{{TableRowN| None           | 0                           | Account ID
}}{{TableRowN| Alarm          | 1                            | Session ID
}}{{TableRowN| OK               | 2                        | "read"
}}{{TableRowN| Pending          | 3                          | The parent device of the "zone" resource. See [[Sensaphone.net_API/device|device]].
}}{{TableRowN| Open           | 4                            | The zone object.
}}{{TableRowN| Closed             | 5                        | ID of the zone.
}}{{TableRowN| Cycle             | 6                     | Zone's child properties to be edited*
}}{{TableRowN| Low             | 7                     | Zone's child properties to be edited*
}}{{TableRowN| High             | 8                     | Zone's child properties to be edited*
}}{{TableRowN| Off             | 9                     | Zone's child properties to be edited*
}}{{TableRowN| On             | 10                     | Zone's child properties to be edited*
}}{{TableRowN| Return To Normal             | 11                     | Zone's child properties to be edited*
}}{{TableRowN| Route Down             | 12                     | Zone's child properties to be edited*
}}{{TableRowN| Trouble             | 13                     | Zone's child properties to be edited*
}}{{TableRowN| Not Responding             | 14                     | Zone's child properties to be edited*
}}{{TableRowN| Dependency Failure             | 15                     | Zone's child properties to be edited*
}}{{TableRowN| Battery             | 16                     | Zone's child properties to be edited*
}}{{TableRowN| Acknowledged             | 17                     | Zone's child properties to be edited*
}}{{TableRowN| Unacknowledged             | 18                     | Zone's child properties to be edited*
}}{{TableEnd}}

'''Output Mode Type''' {{TableStart|border_size=1
}}{{TableRowN| '''Child Property''' |'''Type'''        | '''Description'''
}}{{TableRowN|  name                   | String          | Name
}}{{TableRowN|  action                  | String          | Action
}}{{TableRowN|  zone_list             | Array of Objects           | List of zones
}}{{TableRowN| type_list                   | Array of Objects | List of Zone type
}}{{TableRowN|  trigger                    | String | Trigger
}}{{TableRowN|  compare_on                    | String | Compare On
}}{{TableRowN|  compare_off                    | String | Compare Off
}}{{TableRowN|  limit_on                    | Float | Limit On
}}{{TableRowN|  limit_off                    | Float | Limit Off
}}{{TableRowN|  zone_on                    | String | Zone On
}}{{TableRowN|  zone_off                    | String | Zone Off
}}{{TableEnd}}

=== GET ===

An error will be issued if attempting to receive a Zone property that does not correspond to the Zone type.

'''URI Mode Request URI's:'''

*Retrieve all information for every one of a device's zones. 

   '''GET''' <nowiki>https://</nowiki>rest.sensaphone.net/api/v1/{ACCTID}/{SESSIONID}/device/{DEVICE_ID}/zone

*Retrieve all the zone IDs for every one of a device's zones. 

   '''GET''' <nowiki>https://</nowiki>rest.sensaphone.net/api/v1/{ACCTID}/{SESSIONID}/device/{DEVICE_ID}/zone/zone_id

*Retrieve all information for a single zone. 

   '''GET''' <nowiki>https://</nowiki>rest.sensaphone.net/api/v1/{ACCTID}/{SESSIONID}/device/{DEVICE_ID}/zone/{ZONE_ID}

*Retrieve the a specific zone's type. 

   '''GET''' <nowiki>https://</nowiki>rest.sensaphone.net/api/v1/{ACCTID}/{SESSIONID}/device/{DEVICE_ID}/zone/{ZONE_ID}/type

'''JSON Mode Request URI:'''

   '''POST''' <nowiki>https://</nowiki>rest.sensaphone.net/api/v1/device/zone

'''JSON Mode Request Properties''' {{TableStart|border_size=1
}}{{TableRowN| '''Parent Property'''|'''Child Property''' |'''Type'''        | '''Description'''
}}{{TableRowN| &nbsp;          | acctid                   | Integer          | Account ID
}}{{TableRowN| &nbsp;          | session                  | Integer          | Session ID
}}{{TableRowN| &nbsp;          | request_type             | String           | "read"
}}{{TableRowN| &nbsp;          | device                   | Array of Objects | The parent device of the "zone" resource. See [[Sensaphone.net_API/device|device]].
}}{{TableRowN| device          | zone                     | Array of Objects | The zone object
}}{{TableEnd}}

'''JSON Mode Response Properties''' {{TableStart|border_size=1
}}{{TableRowN| '''Parent Property''' |'''Child Property'''|'''Status'''| '''Type'''       | '''Description'''
}}{{TableRowN| &nbsp;                | device             | Required   | Array of Objects | The parent device object.
}}{{TableRowN| device                | zone               | Required   | Array of Objects | The zone object.
}}{{TableRowN| zone                  | zone_id          | Required   | Integer          | ID of the zone.
}}{{TableRowN| zone                  | index_id           | Optional   | Integer         | Zone ordering.
}}{{TableRowN| zone                  | name               | Optional   | String           | Name of the zone.
}}{{TableRowN| zone                  | canonical_name        | Optional   | String  | Canonical name of the zone.
}}{{TableRowN| zone                  | type               | Optional   | String           | The zone type. (Use a V2 [[Sensaphone.net_API/zone#GET|read command]] to retrieve the valid values)
}}{{TableRowN| type                  | type_list          | Optional   | Array of Objects | The zone type metadata.
}}{{TableRowN| type_list             | name               | Optional   | Boolean          | Zone Type Metadata: Name corresponds to the ranged values for the zone type.
}}{{TableRowN| type_list             | is_digital         | Optional   | Boolean          | Zone Type Metadata: Digital
}}{{TableRowN| type_list             | is_analog          | Optional   | Boolean          | Zone Type Metadata: Analog
}}{{TableRowN| type_list             | is_internal        | Optional   | Boolean          | Zone Type Metadata: Internal
}}{{TableRowN| type_list             | is_external        | Optional   | Boolean          | Zone Type Metadata: External
}}{{TableRowN| type_list             | is_generic         | Optional   | Boolean          | Zone Type Metadata: Generic
}}{{TableRowN| type_list             | is_input           | Optional   | Boolean          | Zone Type Metadata: Input
}}{{TableRowN| type_list             | is_output          | Optional   | Boolean          | Zone Type Metadata: Output
}}{{TableRowN| type_list             | is_ipalarm         | Optional   | Boolean          | Zone Type Metadata: IP Alarm
}}{{TableRowN| type_list             | is_alarmable       | Optional   | Boolean          | Zone Type Metadata: Alarmable
}}{{TableRowN| type_list             | is_tablerange      | Optional   | Boolean          | Zone Type Metadata: Table Ranged
}}{{TableRowN| type_list             | is_loggable        | Optional   | Boolean          | Zone Type Metadata: Loggable
}}{{TableRowN| type_list             | is_alarm_low       | Optional   | Boolean          | Zone Type Metadata: Alarm Low
}}{{TableRowN| type_list             | is_alarm_high      | Optional   | Boolean          | Zone Type Metadata: Alarm High
}}{{TableRowN| type_list             | units_list      | Optional   | Array of Ranges          | Zone Type Metadata: Possible Units
}}{{TableRowN| zone                  | enable             | Optional   | Boolean          | Whether or not the zone is enabled.
}}{{TableRowN| zone                  | value              | Optional   | String           | The data value for the zone.
}}{{TableRowN| zone                  | units              | Optional   | String           | The custom units for the zone.
}}{{TableRowN| zone                  | schedule           | Optional   | Object           | (See [[Sensaphone.net API/schedule|Sensaphone.net API/schedule]])
}}{{TableRowN| zone                  | alarm_zone         | Optional   | Object           | Sub-object containing data for alarmable zones. 'null' if unsupported.
}}{{TableRowN| alarm_zone            | alarm_rtn          | Optional   | Boolean or null  | Whether or not a return-to-normal alarm is enabled. 'null' if the feature is not supported.
}}{{TableRowN| alarm_zone            | alarm_hold         | Optional   | Integer          | The alarm hold (or clear delay) time.
}}{{TableRowN| alarm_zone            | alarm_enable       | Optional   | Boolean          | Whether or not alarming is enabled for this zone.
}}{{TableRowN| alarm_zone            | rec_time           | Optional   | Integer          | The alarm recognition time.
}}{{TableRowN| alarm_zone            | reset_time         | Optional   | Integer          | The alarm reset time.
}}{{TableRowN| alarm_zone            | alarm_low         | Optional   | Floating Point          | The alarm low limit.
}}{{TableRowN| alarm_zone            | alarm_high         | Optional   | Floating Point          | The alarm high limit.
}}{{TableRowN| alarm_zone            | is_last_ack_supported         | Optional   | Boolean          | Whether or not last acknowledge is supported
}}{{TableRowN| alarm_zone            | is_last_alarm_supported         | Optional   | Boolean          | Whether or not last alarm is supported
}}{{TableRowN| alarm_zone            | last_ack         | Optional   | String          | The date of the last acknowledge
}}{{TableRowN| alarm_zone            | last_alarm         | Optional   | String          | The date of the last alarm
}}{{TableRowN| alarm_zone            | alarm_condition         | Optional   | Array of ZoneState          |  The highest priority ZoneState that has been reached
}}{{TableRowN| alarm_zone            | alarm_status         | Optional   | Array of ZoneState          |   The processed status of the zone ( returns 2 ZoneStates)
}}{{TableRowN| alarm_zone            | current_status         | Optional   | Array of ZoneState          |  The real-time status of the zone input (returns 1 ZoneState)
}}{{TableRowN| alarm_zone            | unack_alarms         | Optional   | Array of ZoneState          |  Alarm states that are currently unacknowledged 
}}{{TableRowN| zone                  | analog_zone        | Optional   | Object           | Sub-object containing data for analog zones. 'null' if unsupported.
}}{{TableRowN| analog_zone           | minimum            | Optional   | Floating Point   | The minimum "value" seen.
}}{{TableRowN| analog_zone           | maximum            | Optional   | Floating Point   | The maximum "value" seen.
}}{{TableRowN| analog_zone           | calibration        | Optional   | Floating Point   | The calibration factor applied to the "value".
}}{{TableRowN| zone                  | table_zone         | Optional   | Object           | Sub-object containing data for table-based zones. 'null' if unsupported.
}}{{TableRowN| table_zone            | table_low                | Optional   | Floating Point   | The low table range for the zone. Used for 4-20mA sensors.
}}{{TableRowN| table_zone            | table_high               | Optional   | Floating Point   | The high table range for the zone. Used for 4-20mA sensors.
}}{{TableRowN| zone                  | log_zone           | Optional   | Object           | Sub-object containing data for loggable zones. 'null' if unsupported.
}}{{TableRowN| log_zone              | report_mode        | Optional   | String           | The reporting option.
}}{{TableRowN| log_zone              | alarm_interval     | Optional   | Integer          | The datalogging interval for when in alarm.
}}{{TableRowN| log_zone              | normal_interval    | Optional   | Integer          | The datalogging interval for when not in alarm.
}}{{TableRowN| log_zone              | enable             | Optional   | Boolean          | Whether or not datalogging is enabled.
}}{{TableRowN| zone                  | pulse_zone         | Optional   | Object           | Sub-object containing data for pulse count capable zones. 'null' if unsupported.
}}{{TableRowN| pulse_zone            | enable             | Optional   | Boolean          | Whether or not pulse counting is enabled for this zone.
}}{{TableRowN| pulse_zone            | multiply           | Optional   | Integer          | The multiplication factor to apply to each pulse.
}}{{TableRowN| pulse_zone            | count              | Optional   | Integer          | The number of pulses seen (after multiply has been applied)
}}{{TableRowN| zone                  | runtime_zone       | Optional   | Object           | Sub-object containing data for runtime capable zones. 'null' if unsupported.
}}{{TableRowN| runtime_zone          | enable             | Optional   | Boolean          | Whether or not runtime is enabled for this zone.
}}{{TableRowN| runtime_zone          | runtime            | Optional   | String           | The run time elapsed.
}}{{TableRowN| zone                  | modbus_zone        | Optional   | Object           | Sub-object containing data for modbus zones. 'null' if unsupported.
}}{{TableRowN| modbus_zone           | media_port         | Optional   | String           | The modbus media port
}}{{TableRowN| modbus_zone           | slave_id           | Optional   | Integer          | The modbus slave ID
}}{{TableRowN| modbus_zone           | command            | Optional   | String           | The modbus command
}}{{TableRowN| modbus_zone           | address            | Optional   | Integer          | The modbus address
}}{{TableRowN| modbus_zone           | byte_order         | Optional   | String           | The modbus byte order
}}{{TableRowN| modbus_zone           | register_order     | Optional   | String           | The modbus register order
}}{{TableRowN| modbus_zone           | register_size      | Optional   | String           | The modbus register size
}}{{TableRowN| modbus_zone           | format             | Optional   | String           | The modbus format
}}{{TableRowN| modbus_zone           | sign               | Optional   | String           | The modbus sign
}}{{TableRowN| modbus_zone           | scaling_offset     | Optional   | Integer          | The modbus scaling offset
}}{{TableRowN| modbus_zone           | scaling_factor     | Optional   | Integer          | The modbus scaling factor
}}{{TableRowN| modbus_zone           | scaling_mode       | Optional   | String           | The modbus scaling mode
}}{{TableRowN| zone                  | output_zone        | Optional   | Object           | Sub-object containing data for output zones. 'null' if unsupported.
}}{{TableRowN| output_zone           | mode               | Optional   | Output Mode Type           | The output mode
}}{{TableRowN| output_zone           | mode_list          | Optional   | Array of  Output Mode Type           | The list of output modes
}}{{TableRowN| output_zone           | set_point_on       | Optional   | Floating Point   | The output set point for the "on" state.
}}{{TableRowN| output_zone           | set_point_off      | Optional   | Floating Point   | The output set point for the "off" state.
}}{{TableRowN| zone                  | wireless_zone      | Optional   | Object           | Sub-object containing data for wireless zones. 'null' if unsupported.
}}{{TableRowN| wireless_zone         | sampling_rate      | Optional   | Integer          | The sampling rate for the sensor
}}{{TableRowN| wireless_zone         | serial_number      | Optional   | Integer          | The serial number for the wireless sensor.
}}{{TableRowN| wireless_zone         | battery_level      | Optional   | String           | The wireless sensor's battery level.
}}{{TableRowN| wireless_zone         | power_level        | Optional   | String           | The wireless sensor's power level.
}}{{TableEnd}}

==== Example JSON ====

Receive the status for a specific Zone.

*'''Request JSON''' 

   {
    "acctid": 987654,
    "uuid": "0123-4567-8901",
    "request_type": "read",
    "device":[
     {
       "device_id": 1234,
       "zone":[
        {
          "zone_id":28487,
          "status": "null"
        }
       ]
     }
    ]
  }

*'''Response JSON''' 

 {
  "result":
  {
    "success": true,
    "code": 0,
    "message": "OK"
  },
  "response":
  {
    "device":[
     {
       "device_id": 1234,
       "zone":[
        {
          "zone_id": 28487,
          "status": "OK"
        }
       ]
     }
    ]
  }
 }

===PUT===
'''URI Mode Request URI's:'''
*Edit a Zone name 
   '''PUT'''  <nowiki>https://</nowiki>rest.sensaphone.net/api/v1/{ACCTID}/{SESSIONID}/device/{DEVICE_ID}/zone/{ZONE_ID}/name/{ZONE_NAME}
*Edit a Zone's recognition time value 
   '''PUT'''  <nowiki>https://</nowiki>rest.sensaphone.net/api/v1/{ACCTID}/{SESSIONID}/device/{DEVICE_ID}/zone/{ZONE_ID}/alarm_zone/rec_time/{REC_TIME}

'''JSON Mode Request URI:'''
   '''POST''' <nowiki>https://</nowiki>rest.sensaphone.net/api/v1/device/zone

'''JSON Mode Request Properties'''
{{TableStart|border_size=1
}}{{TableRowN| '''Parent Property'''|'''Child Property''' |'''Type'''        | '''Description'''
}}{{TableRowN| &nbsp;          | acctid                   | Integer          | Account ID
}}{{TableRowN| &nbsp;          | session                  | Integer          | Session ID
}}{{TableRowN| &nbsp;          | request_type             | String           | "read"
}}{{TableRowN| &nbsp;          | device                   | Array of Objects | The parent device of the "zone" resource. See [[Sensaphone.net_API/device|device]].
}}{{TableRowN| device          | zone                     | Array of Objects | The zone object.
}}{{TableRowN| zone            | zone_id                  | Integer          | ID of the zone.
}}{{TableRowN| zone            | '''''CHILD PROPERTY''''' | &nbsp;           | Zone's child properties to be edited*
}}{{TableEnd}}
<nowiki>*</nowiki> One or more '''zone''' child properties listed below are required in addition to "zone_id".

'''JSON Mode Response Properties'''
{{TableStart|border_size=1
}}{{TableRowN| '''Parent Property''' |'''Child Property'''|'''Status'''| '''Type'''       | '''Description'''
}}{{TableRowN| &nbsp;                | device             | Required   | Array of Objects | The parent device object.
}}{{TableRowN| device                | zone               | Required   | Array of Objects | The zone object.
}}{{TableRowN| zone                  | zone_id          | Required   | Integer          | ID of the zone.
}}{{TableRowN| zone                  | index_id           | Optional   | Integer          | Zone ordering.
}}{{TableRowN| zone                  | name               | Optional   | String           | Name of the zone.
}}{{TableRowN| zone                  | type               | Optional   | String           | The zone type. (Use a V2 [[Sensaphone.net_API/zone#GET|read command]] to retrieve the valid values)
}}{{TableRowN| zone                  | enable             | Optional   | Boolean          | Whether or not the zone is enabled.
}}{{TableRowN| zone                  | value              | Optional   | String           | The data value for the zone.
}}{{TableRowN| zone                  | units              | Optional   | String           | The custom units for the zone.
}}{{TableRowN| zone                  | schedule           | Optional   | Object           | (See [[Sensaphone.net API/schedule|Sensaphone.net API/schedule]])
}}{{TableRowN| zone                  | alarm_zone         | Optional   | Object           | Sub-object containing data for alarmable zones. 'null' if unsupported.
}}{{TableRowN| alarm_zone            | alarm_rtn          | Optional   | Boolean or null  | Whether or not a return-to-normal alarm is enabled. 'null' if the feature is not supported.
}}{{TableRowN| alarm_zone            | alarm_hold         | Optional   | Integer          | The alarm hold (or clear delay) time.
}}{{TableRowN| alarm_zone            | alarm_enable       | Optional   | Boolean          | Whether or not alarming is enabled for this zone.
}}{{TableRowN| alarm_zone            | rec_time           | Optional   | Integer          | The alarm recognition time.
}}{{TableRowN| alarm_zone            | reset_time         | Optional   | Integer          | The alarm reset time.
}}{{TableRowN| alarm_zone            | alarm_low         | Optional   | Floating Point          | The alarm low limit.
}}{{TableRowN| alarm_zone            | alarm_high         | Optional   | Floating Point          | The alarm high limit.
}}{{TableRowN| zone                  | analog_zone        | Optional   | Object           | Sub-object containing data for analog zones. 'null' if unsupported.
}}{{TableRowN| analog_zone           | clear_min          | Optional   | Boolean          | Clear the minimum value.
}}{{TableRowN| analog_zone           | clear_max          | Optional   | Boolean          | Clear the maximum value.
}}{{TableRowN| analog_zone           | calibration        | Optional   | Floating Point   | The calibration factor applied to the "value".
}}{{TableRowN| zone                  | table_zone         | Optional   | Object           | Sub-object containing data for table-based zones. 'null' if unsupported.
}}{{TableRowN| table_zone            | table_low                | Optional   | Floating Point   | The low table range for the zone. Used for 4-20mA sensors.
}}{{TableRowN| table_zone            | table_high               | Optional   | Floating Point   | The high table range for the zone. Used for 4-20mA sensors.
}}{{TableRowN| zone                  | log_zone           | Optional   | Object           | Sub-object containing data for loggable zones. 'null' if unsupported.
}}{{TableRowN| log_zone              | report_mode        | Optional   | String           | The reporting option.
}}{{TableRowN| log_zone              | alarm_interval     | Optional   | Integer          | The datalogging interval for when in alarm.
}}{{TableRowN| log_zone              | normal_interval    | Optional   | Integer          | The datalogging interval for when not in alarm.
}}{{TableRowN| log_zone              | enable             | Optional   | Boolean          | Whether or not datalogging is enabled.
}}{{TableRowN| zone                  | pulse_zone         | Optional   | Object           | Sub-object containing data for pulse count capable zones. 'null' if unsupported.
}}{{TableRowN| pulse_zone            | enable             | Optional   | Boolean          | Whether or not pulse counting is enabled for this zone.
}}{{TableRowN| pulse_zone            | multiply           | Optional   | Integer          | The multiplication factor to apply to each pulse.
}}{{TableRowN| pulse_zone            | count              | Optional   | Integer          | The number of pulses seen (after multiply has been applied)
}}{{TableRowN| zone                  | runtime_zone       | Optional   | Object           | Sub-object containing data for runtime capable zones. 'null' if unsupported.
}}{{TableRowN| runtime_zone          | enable             | Optional   | Boolean          | Whether or not runtime is enabled for this zone.
}}{{TableRowN| runtime_zone          | runtime            | Optional   | String           | The run time elapsed.
}}{{TableRowN| zone                  | modbus_zone        | Optional   | Object           | Sub-object containing data for modbus zones. 'null' if unsupported.
}}{{TableRowN| modbus_zone           | media_port         | Optional   | String           | The modbus media port
}}{{TableRowN| modbus_zone           | slave_id           | Optional   | Integer          | The modbus slave ID
}}{{TableRowN| modbus_zone           | command            | Optional   | String           | The modbus command
}}{{TableRowN| modbus_zone           | address            | Optional   | Integer          | The modbus address
}}{{TableRowN| modbus_zone           | byte_order         | Optional   | String           | The modbus byte order
}}{{TableRowN| modbus_zone           | register_order     | Optional   | String           | The modbus register order
}}{{TableRowN| modbus_zone           | register_size      | Optional   | String           | The modbus register size
}}{{TableRowN| modbus_zone           | format             | Optional   | String           | The modbus format
}}{{TableRowN| modbus_zone           | sign               | Optional   | String           | The modbus sign
}}{{TableRowN| modbus_zone           | scaling_offset     | Optional   | Integer          | The modbus scaling offset
}}{{TableRowN| modbus_zone           | scaling_factor     | Optional   | Integer          | The modbus scaling factor
}}{{TableRowN| modbus_zone           | scaling_mode       | Optional   | String           | The modbus scaling mode
}}{{TableRowN| zone                  | output_zone        | Optional   | Object           | Sub-object containing data for output zones. 'null' if unsupported.
}}{{TableRowN| output_zone           | mode               | Optional   | String           | The output mode
}}{{TableRowN| output_zone           | mode_list          | Optional   | String           | The list of output modes
}}{{TableRowN| output_zone           | set_point_on       | Optional   | Floating Point   | The output set point for the "on" state.
}}{{TableRowN| output_zone           | set_point_off      | Optional   | Floating Point   | The output set point for the "off" state.
}}{{TableRowN| output_zone           | value      | Optional   | Floating Point   | *Write Only* set the value of the output zone
}}{{TableRowN| zone                  | wireless_zone      | Optional   | Object           | Sub-object containing data for wireless zones. 'null' if unsupported.
}}{{TableRowN| wireless_zone         | sampling_rate      | Optional   | Integer          | The sampling rate for the sensor
}}{{TableRowN| wireless_zone         | serial_number      | Optional   | Integer          | The serial number for the wireless sensor.
}}{{TableEnd}}

===POST===
'''URI Mode Request URI's:'''
*Acknowledge All Zone Alarms
   '''POST'''  <nowiki>https://</nowiki>rest.sensaphone.net/api/v1/{ACCTID}/{SESSIONID}/device/{DEVICE_ID}/zone/{ZONE_ID}/alarm_zone/acknowledge_all_alarms/{true}

'''JSON Mode Request URI:'''
   '''POST''' <nowiki>https://</nowiki>rest.sensaphone.net/api/v1/device/zone

'''JSON Mode Request Properties'''
{{TableStart|border_size=1
}}{{TableRowN| '''Parent Property'''|'''Child Property''' |'''Type'''        | '''Description'''
}}{{TableRowN| &nbsp;          | acctid                   | Integer          | Account ID
}}{{TableRowN| &nbsp;          | session                  | Integer          | Session ID
}}{{TableRowN| &nbsp;          | request_type             | String           | "read"
}}{{TableRowN| &nbsp;          | device                   | Array of Objects | The parent device of the "zone" resource. See [[Sensaphone.net_API/device|device]].
}}{{TableRowN| device          | zone                     | Array of Objects | The zone object.
}}{{TableRowN| zone            | zone_id                  | Integer          | ID of the zone.
}}{{TableRowN| zone            | alarm_zone | Object           |  Sub-object containing data for alarmable zones
}}{{TableRowN| alarm_zone            | acknowledge_alarms | Array of Zone State           |  A write-only property to acknowledge specific alarms
}}{{TableRowN| alarm_zone            | acknowledge_all_alarms | Boolean           |  A write-only property to acknowledge all alarms for a zone
}}{{TableEnd}}
<nowiki>*</nowiki> "acknowledge_all_alarms" supersedes "acknowledge_alarms", if it is present in the request json other properties will be ignored

'''JSON Mode Result Properties'''
{{TableStart|border_size=1
}}{{TableRowN| '''Parent Property''' |'''Child Property'''|'''Status'''| '''Type'''       | '''Description'''
}}{{TableRowN| &nbsp;                | device             | Required   | Array of Objects | The parent device object.
}}{{TableRowN| device                | zone               | Required   | Array of Objects | The zone object.
}}{{TableRowN| zone                  | zone_id          | Required   | Integer          | ID of the zone.
}}{{TableRowN| zone                  | alarm_zone         | Required   | Object           | Sub-object containing data for alarmable zones. 'null' if unsupported.
}}{{TableRowN| alarm_zone            | acknowledge_alarms          | Optional   | Array of Zone State  |  A write-only property to acknowledge specific alarms
}}{{TableRowN| alarm_zone            | acknowledge_all_alarms         | Optional   | Boolean          | A write-only property to acknowledge all alarms for a zone
}}{{TableEnd}}

=== Example JSON ===

Acknowledge an alarm for a Zone

*'''Request JSON''' 

 {
  "request_type": "create",
  "resource": "device",
  "acctid": 987654,
  "session": "0123-4567-8901",
  "device": [
    {
      "device_id": 1234,
      "zone": [
        {
          "zone_id": 7,
          "alarm_zone": {
            "acknowledge_alarms": [
              11,
              4
            ]
          }
        }
      ]
    }
  ]
 }

*'''Response JSON''' 

 {
  "result": {
    "success": true,
    "code": 0,
    "message": "OK",
    "properties": {
      "device": [
        {
          "device_id": 1234,
          "zone": [
            {
              "alarm_zone": [
                {
                  "acknowledge_alarms": 11,
                  "code": 0,
                  "message": "OK",
                  "success": true
                },
                {
                  "acknowledge_alarms": 4,
                  "code": 0,
                  "message": "OK",
                  "success": true
                }
              ],
              "zone_id": 7
            }
          ]
        }
      ]
    }
  }
 }