Revision as of 14:08, 30 April 2015

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

Zone States

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 https://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 https://rest.sensaphone.net/api/v1/{ACCTID}/{SESSIONID}/device/{DEVICE_ID}/zone/zone_id

• Retrieve all information for a single zone.

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

• Retrieve the a specific zone's type.

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

JSON Mode Request URI:

  POST https://rest.sensaphone.net/api/v1/device/zone

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  https://rest.sensaphone.net/api/v1/{ACCTID}/{SESSIONID}/device/{DEVICE_ID}/zone/{ZONE_ID}/name/{ZONE_NAME}

• Edit a Zone's recognition time value

  PUT  https://rest.sensaphone.net/api/v1/{ACCTID}/{SESSIONID}/device/{DEVICE_ID}/zone/{ZONE_ID}/alarm_zone/rec_time/{REC_TIME}

JSON Mode Request URI:

  POST https://rest.sensaphone.net/api/v1/device/zone

JSON Mode Request Properties

* One or more zone child properties listed below are required in addition to "zone_id".

JSON Mode Response Properties

POST

URI Mode Request URI's:

• Acknowledge All Zone Alarms

  POST  https://rest.sensaphone.net/api/v1/{ACCTID}/{SESSIONID}/device/{DEVICE_ID}/zone/{ZONE_ID}/alarm_zone/acknowledge_all_alarms/{true}

JSON Mode Request URI:

  POST https://rest.sensaphone.net/api/v1/device/zone

JSON Mode Request Properties

* "acknowledge_all_alarms" supersedes "acknowledge_alarms", if it is present in the request json other properties will be ignored

JSON Mode Result Properties

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
           }
         ]
       }
     ]
   }
 }
}