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

2025-07-10T15:42:43Z

‎Sensaphone.net API: Update Session data type.

Tim: Created page with "=Sensaphone.net API= ==Specifications== The schedule resource has the following properties: {{TableStart|border_size=1 }}{{TableRowN| '''Parent Property'''|'''Property'''..."

2015-04-29T19:22:58Z

Created page with "=Sensaphone.net API= ==Specifications== The schedule resource has the following properties: {{TableStart|border_size=1 }}{{TableRowN| '''Parent Property'''|'''Property'''..."

New page

=[[Sensaphone.net API]]=
==Specifications==
The schedule resource has the following properties:
{{TableStart|border_size=1
}}{{TableRowN| '''Parent Property'''|'''Property''' | '''Type''' | '''Description''' | '''Create''' | '''Delete''' | '''Read''' | '''Update'''
}}{{TableRowN| ''<parent>'' | timerange | Array of Objects | The schedule's time ranges | '''✓''' | '''✓''' | '''✓''' | '''n/a'''
}}{{TableRowN| timerange | range_id | Integer | ID of the time range. | ''' ''' | ''' ''' | '''✓''' | ''' '''
}}{{TableRowN| timerange | start | String | The start time | ''' ''' | ''' ''' | '''✓''' | '''✓'''
}}{{TableRowN| timerange | end | String | The end time | ''' ''' | ''' ''' | '''✓''' | '''✓'''
}}{{TableRowN| timerange | interval | Integer (Bitmap) | Time interval options (see table) | ''' ''' | ''' ''' | '''✓''' | '''✓'''
}}{{TableEnd}}

The interval is a bitmap containing the following options. "Bit 1" is the low-order bit in the '''interval''' unsigned integer. The default value "Sunday + Monday + Tuesday + Wednesday + Thursday + Friday + Saturday", matches every day that matches the "start" and "end".
{{TableStart|border_size=1
}}{{TableRowN| '''Bit Position''' | '''Description'''
}}{{TableRowN| 1 | Timestamp: Sunday
}}{{TableRowN| 2 | Timestamp: Monday
}}{{TableRowN| 3 | Timestamp: Tuesday
}}{{TableRowN| 4 | Timestamp: Wednesday
}}{{TableRowN| 5 | Timestamp: Thursday
}}{{TableRowN| 6 | Timestamp: Friday
}}{{TableRowN| 7 | Timestamp: Saturday
}}{{TableRowN| 8 | Datetime: Is a holiday
}}{{TableRowN| 9 | Datetime: Interpret "start" and "end" as a datetime not a timestamp.
}}{{TableRowN| 10 | Datetime: Repeat: Daily
}}{{TableRowN| 11 | Datetime: Repeat: Weekly
}}{{TableRowN| 12 | Datetime: Repeat: Yearly (Day Number)
}}{{TableRowN| 13 | Datetime: Repeat: Yearly (Day of Week)
}}{{TableRowN| 14 | Invert selection. The timerange represents a time NOT selected.
}}{{TableRowN| 15 | Reserved
}}{{TableEnd}}

===GET===
'''URI Mode Request URI's:'''
*Retrieve all information for all of a schedule's timeranges.
'''GET''' <nowiki>https://</nowiki>rest.sensaphone.net/api/v1/{ACCTID}/{SESSIONID}/user/{USER_ID}/contact/{CONTACT_ID}/schedule/{SCHEDULE_ID}/timerange

'''JSON Mode Request URI:'''
'''POST''' <nowiki>https://</nowiki>rest.sensaphone.net/api/v1/user/contact/schedule/timerange

'''JSON Mode Request Properties'''
{{TableStart|border_size=1
}}{{TableRowN| '''Parent Property'''|'''Child Property''' |'''Type''' | '''Description'''
}}{{TableRowN|   | acctid | Integer | Account ID
}}{{TableRowN|   | session | Integer | Session ID
}}{{TableRowN|   | request_type | String | "read"
}}{{TableRowN|   | ''<parent object(s)>'' | Array of Objects | The parent(s) of the "timerange" resource, if any. See the [[Sensaphone.net_API#List|'''list''']].
}}{{TableRowN| ''<parent>'' | timerange | Array of Objects | The timerange object
}}{{TableEnd}}

'''JSON Mode Response Properties'''
{{TableStart|border_size=1
}}{{TableRowN| '''Parent Property'''|'''Child Property'''|'''Status''' | '''Type''' | '''Description'''
}}{{TableRowN|   | ''<parent object(s)>'' | Optional | Array of Objects | The parent(s) specified in the request.
}}{{TableRowN| ''<parent>'' | timerange | Required | Array of Objects | The timerange object
}}{{TableRowN| timerange | range_id | Optional | Integer | ID for timerange
}}{{TableRowN| timerange | start | Optional | String | The start time
}}{{TableRowN| timerange | end | Optional | String | The end time
}}{{TableRowN| timerange | interval | Optional | Integer (Bitmap) | Time interval options (see table)
}}{{TableEnd}}

====Example JSON====
Retrieve time range information.

*'''Request JSON'''

{
"acctid": 987654,
"uuid": "0123-4567-8901",
"request_type": "read",
"device":[
{
"device_id": 1234,
"default_schedule":[
{
"schedule_id":28487,
"timerange": null
}
]
}
]
}

*'''Response JSON'''
{
"result":
{
"success": true,
"code": 0,
"message": "OK"
},
"response":
{
"device":[
{
"device_id": 1234,
"default_schedule":[
{
"schedule_id":28487,
"timerange":[
{
"range_id": 58381
"start": "..TBD..",
"end": "..TBD..",
"interval": 127
},
{
"range_id": 51587
"start": "..TBD..",
"end": "..TBD..",
"interval": 7
}
]
}
]
}
]
}
}

===PUT===
'''URI Mode Request URI's'''
*Edit the '''interval''' of a time range
'''PUT''' <nowiki>https://</nowiki>rest.sensaphone.net/api/v1/{ACCTID}/{SESSIONID}/device/{DEVICE_ID}/default_schedule/{SCHEDULE_ID}/timerange/{RANGE_ID}/interval/{INTERVAL}

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

'''JSON Mode Request Properties'''
{{TableStart|border_size=1
}}{{TableRowN| '''Parent Property'''|'''Child Property''' |'''Type''' | '''Description'''
}}{{TableRowN|   | acctid | Integer | Account ID
}}{{TableRowN|   | session | Integer | Session ID
}}{{TableRowN|   | request_type | String | "update"
}}{{TableRowN|   | ''<parent object(s)>'' | Array of Objects | The parent(s) of the "timerange" resource, if any. See the [[Sensaphone.net_API#List|'''list''']].
}}{{TableRowN| ''<parent>'' | timerange | Array of Objects | The timerange object
}}{{TableRowN| timerange | range_id | Integer | ID for time range
}}{{TableRowN| timerange | '''''CHILD PROPERTY''''' |   | Child properties to be edited *
}}{{TableEnd}}
<nowiki>*</nowiki> One or more '''timerange''' child properties listed below are required in addition to "range_id".

'''JSON Mode Response Properties'''
{{TableStart|border_size=1
}}{{TableRowN| '''Parent Property'''|'''Child Property'''|'''Status''' | '''Type''' | '''Description'''
}}{{TableRowN|   | ''<parent object(s)>'' | Optional | Array of Objects | The parent(s) specified in the request.
}}{{TableRowN| ''<parent>'' | timerange | Required | Array of Objects | The timerange object
}}{{TableRowN| timerange | range_id | Optional | Integer | ID for timerange
}}{{TableRowN| timerange | start | Optional | String | The start time
}}{{TableRowN| timerange | end | Optional | String | The end time
}}{{TableRowN| timerange | interval | Optional | Integer (Bitmap) | Time interval options (see table)
}}{{TableEnd}}

===POST===
'''URI Mode Request URI's'''
*Create a new time range with default values.
'''POST''' <nowiki>https://</nowiki>rest.sensaphone.net/api/v1/{ACCTID}/{SESSIONID}/device/{DEVICE_ID}/default_schedule/{SCHEDULE_ID}/timerange

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

'''JSON Mode Request Properties'''
{{TableStart|border_size=1
}}{{TableRowN| '''Parent Property'''|'''Child Property''' |'''Type''' | '''Description'''
}}{{TableRowN|   | acctid | Integer | Account ID
}}{{TableRowN|   | session | Integer | Session ID
}}{{TableRowN|   | request_type | String | "create"
}}{{TableRowN|   | ''<parent object(s)>'' | Array of Objects | The parent(s) of the "timerange" resource, if any. See the [[Sensaphone.net_API#List|'''list''']].
}}{{TableRowN| ''<parent>'' | timerange | Array of Objects | The timerange object
}}{{TableRowN| timerange | '''''CHILD PROPERTY''''' |   | Child properties to be set *
}}{{TableEnd}}
<nowiki>*</nowiki> One or more '''timerange''' child properties below ''may'' be specified in addition to "range_id".

'''JSON Mode Response Properties'''
{{TableStart|border_size=1
}}{{TableRowN| '''Parent Property'''|'''Child Property'''|'''Status''' | '''Type''' | '''Description'''
}}{{TableRowN|   | ''<parent object(s)>'' | Optional | Array of Objects | The parent(s) specified in the request.
}}{{TableRowN| ''<parent>'' | timerange | Required | Array of Objects | The timerange object
}}{{TableRowN| timerange | range_id | Optional | Integer | ID for timerange
}}{{TableRowN| timerange | start | Optional | String | The start time
}}{{TableRowN| timerange | end | Optional | String | The end time
}}{{TableRowN| timerange | interval | Optional | Integer (Bitmap) | Time interval options (see table)
}}{{TableEnd}}

===DELETE===
'''URI Mode Request URI's'''
*Create a new time range with default values.
'''DELETE''' <nowiki>https://</nowiki>rest.sensaphone.net/api/v1/{ACCTID}/{SESSIONID}/device/{DEVICE_ID}/default_schedule/{SCHEDULE_ID}/timerange/{RANGE_ID}

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

'''JSON Mode Request Properties'''
{{TableStart|border_size=1
}}{{TableRowN| '''Parent Property'''|'''Child Property''' |'''Type''' | '''Description'''
}}{{TableRowN|   | acctid | Integer | Account ID
}}{{TableRowN|   | session | Integer | Session ID
}}{{TableRowN|   | request_type | String | "delete"
}}{{TableRowN|   | ''<parent object(s)>'' | Array of Objects | The parent(s) of the "timerange" resource, if any. See the [[Sensaphone.net_API#List|'''list''']].
}}{{TableRowN| ''<parent>'' | timerange | Array of Objects | The timerange object
}}{{TableRowN| timerange | range_id | Integer | ID for time range
}}{{TableEnd}}

@@ Line 43: / Line 43: @@
 }}{{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           | "read"
 }}{{TableRowN| &nbsp;          | ''<parent object(s)>''   | Array of Objects | The parent(s) of the "timerange" resource, if any. See the [[Sensaphone.net_API#List|'''list''']].
@@ Line 131: / Line 131: @@
 }}{{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           | "update"
 }}{{TableRowN| &nbsp;          | ''<parent object(s)>''   | Array of Objects | The parent(s) of the "timerange" resource, if any. See the [[Sensaphone.net_API#List|'''list''']].
@@ Line 163: / Line 163: @@
 }}{{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| &nbsp;          | ''<parent object(s)>''   | Array of Objects | The parent(s) of the "timerange" resource, if any. See the [[Sensaphone.net_API#List|'''list''']].
@@ Line 195: / Line 195: @@
 }}{{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           | "delete"
 }}{{TableRowN| &nbsp;          | ''<parent object(s)>''   | Array of Objects | The parent(s) of the "timerange" resource, if any. See the [[Sensaphone.net_API#List|'''list''']].

Sensaphone.net API/timerange - Revision history

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

Tim: Created page with "=Sensaphone.net API= ==Specifications== The schedule resource has the following properties: {{TableStart|border_size=1 }}{{TableRowN| '''Parent Property'''|'''Property'''..."