Sensaphone.net API/alarmschedule - Revision history

Mwood: /* Sensaphone.net API */ Update Session data type.

2025-07-10T15:40:45Z

‎Sensaphone.net API: Update Session data type.

Tim: /* POST */

2015-09-14T13:06:42Z

‎POST

Tim: /* POST */

2015-09-14T13:06:17Z

‎POST

Tim: /* POST */

2015-09-14T13:05:51Z

‎POST

Tim: /* GET */

2015-09-14T13:05:19Z

‎GET

Tim: /* DELETE */

2015-09-14T13:05:02Z

‎DELETE

Tim: /* Specifications */

2015-05-05T19:00:30Z

‎Specifications

Tim: /* DELETE */

2015-05-05T18:59:35Z

‎DELETE

Tim: /* POST */

2015-05-05T18:59:02Z

‎POST

Tim: /* GET */

2015-05-05T18:56:35Z

‎GET

@@ Line 26: / Line 26: @@
 }}{{TableRowN| '''Parent Property'''|'''Child Property''' |'''Type'''        | '''Description'''
 }}{{TableRowN| &nbsp;               | acctid              | Integer          | Account ID
-}}{{TableRowN| &nbsp;               | session             | Integer          | Session ID
+}}{{TableRowN| &nbsp;               | session             | String           | Session Token
 }}{{TableRowN| &nbsp;               | request_type        | String           | "create"
 }}{{TableRowN| ''<parent>''         | alarmschedule       | Object           | The schedule object.
@@ Line 66: / Line 66: @@
 }}{{TableRowN| '''Parent Property'''|'''Child Property''' |'''Type'''        | '''Description'''
 }}{{TableRowN| &nbsp;               | acctid              | Integer          | Account ID
-}}{{TableRowN| &nbsp;               | session             | Integer          | Session ID
+}}{{TableRowN| &nbsp;               | session             | String           | Session Token
 }}{{TableRowN| &nbsp;               | request_type        | String           | "create"
 }}{{TableRowN| ''<parent>''         | alarmschedule       | Object           | The schedule object.
@@ Line 100: / Line 100: @@
 }}{{TableRowN| '''Parent Property'''|'''Child Property''' |'''Type'''        | '''Description'''
 }}{{TableRowN| &nbsp;               | acctid              | Integer          | Account ID
-}}{{TableRowN| &nbsp;               | session             | Integer          | Session ID
+}}{{TableRowN| &nbsp;               | session             | String           | Session Token
 }}{{TableRowN| &nbsp;               | request_type        | String           | "create"
 }}{{TableRowN| ''<parent>''         | alarmschedule       | Object           | The schedule object.
 }}{{TableRowN| alarmschedule        | schedule_id         | Integer          | ID of the schedule.
 }}{{TableEnd}}

@@ Line 60: / Line 60: @@
 '''JSON Mode Request Properties'''
 ''Create new alarm schedule''
 This will create an alarm schedule with an empty call list and the default time range. An empty schedule must exist before its contents can be modified.
 {{TableStart|border_size=1
 }}{{TableRowN| '''Parent Property'''|'''Child Property''' |'''Type'''        | '''Description'''

← Older revision		Revision as of 13:06, 14 September 2015
Line 69:		Line 69:
	}}{{TableEnd}}		}}{{TableEnd}}

−	~~:''Create a new "time range" to "call list" binding.~~
−	~~{{TableStart\|border_size=1~~
−	~~}}{{TableRowN\| '''Parent Property'''\|'''Child Property''' \|'''Type''' \| '''Description'''~~
−	~~}}{{TableRowN\| ''<parent>'' \| alarmschedule \| Object \| The schedule object.~~
−	~~}}{{TableRowN\| alarmschedule \| schedule_id \| Integer \| ID of the schedule.~~
−	~~}}{{TableRowN\| alarmschedule \| timeranges \| Array of Objects \| The mapping of [[Sensaphone.net_API/timerange\|time ranges]] to [[Sensaphone.net_API/calllist\|call lists]]~~
−	~~}}{{TableRowN\| timeranges \| range_id \| Integer \| The ID of the time range.~~
−	~~}}{{TableRowN\| timeranges \| list_id \| Integer \| The ID of the call list.~~
−	~~}}{{TableEnd}}~~

	'''JSON Mode Response Properties'''		'''JSON Mode Response Properties'''

@@ Line 59: / Line 59: @@
 '''JSON Mode Request Properties'''
-:''Create new alarm schedule''
+''Create new alarm schedule''
-:This will create an alarm schedule with an empty call list and the default time range. An empty schedule must exist before its contents can be modified.
+This will create an alarm schedule with an empty call list and the default time range. An empty schedule must exist before its contents can be modified.
-:{{TableStart|border_size=1
+{{TableStart|border_size=1
 }}{{TableRowN| '''Parent Property'''|'''Child Property''' |'''Type'''        | '''Description'''
 }}{{TableRowN| &nbsp;               | acctid              | Integer          | Account ID
@@ Line 70: / Line 70: @@
 :''Create a new "time range" to "call list" binding.
-:{{TableStart|border_size=1
+{{TableStart|border_size=1
 }}{{TableRowN| '''Parent Property'''|'''Child Property''' |'''Type'''        | '''Description'''
 }}{{TableRowN| ''<parent>''         | alarmschedule       | Object           | The schedule object.

@@ Line 23: / Line 23: @@
 '''JSON Mode Request Properties'''
-:{{TableStart|border_size=1
+{{TableStart|border_size=1
 }}{{TableRowN| '''Parent Property'''|'''Child Property''' |'''Type'''        | '''Description'''
 }}{{TableRowN| &nbsp;               | acctid              | Integer          | Account ID

@@ Line 5: / Line 5: @@
 ==Specifications==
-Alarm Schedules define when a [[Sensaphone.net API/contact|Contact]], [[Sensaphone.net API/contactgroup|Contact Group]], or Contact-independent [[Sensaphone.net API/destination|Destinations]] will be notified of an alarm; immediately or with a predefined delay. Delays are user inputted integer values defining the number of minutes to wait after an alarm has been triggered to send a notification to a Contact, Contact Group, and/or Destination. Once an alarm is acknowledged it will not continue notifying subsequent delay tiers.
+Alarm Schedules define when a [[Sensaphone.net API/contact|Contact]],  or [[Sensaphone.net API/contactgroup|Contact Group]] will be notified of an alarm; immediately or with a predefined delay. Delays are user inputted integer values defining the number of minutes to wait after an alarm has been triggered to send a notification to a Contact, Contact Group, and/or Destination. Once an alarm is acknowledged it will not continue notifying subsequent delay tiers.
 The schedule resource has the following properties:

@@ Line 95: / Line 95: @@
 *Delete the device schedule from a device (thus enabling the default schedule).
     '''DELETE''' https://rest.sensaphone.net/api/v1/{ACCTID}/{SESSIONID}/device/{DEVICE_ID}/device_schedule/{SCHEDULE_ID}
 '''JSON Mode Request URI:'''

@@ Line 51: / Line 51: @@
 *Create a new device schedule.
     '''POST''' https://rest.sensaphone.net/api/v1/{ACCTID}/{SESSIONID}/device/{DEVICE_ID}/device_schedule
 '''JSON Mode Request URI:'''