Sensaphone.net API/schedule - Revision history

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

2025-07-10T15:41:40Z

‎Sensaphone.net API: Update Session data type.

Mwood: /* Example JSON */

2024-01-03T21:32:17Z

‎Example JSON

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:32Z

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>'' | schedule | Object | The schedule object. | '''✓''' | '''✓''' | '''✓''' | '''n/a'''
}}{{TableRowN| schedule | schedule_id | Integer | ID of the schedule. | ''' ''' | ''' ''' | '''✓''' | ''' '''
}}{{TableRowN| schedule | timerange | Array of Objects | The schedule's [[Sensaphone.net_API/timerange|time ranges]]
}}{{TableEnd}}

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

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

'''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 "schedule" resource, if any. See the [[Sensaphone.net_API#List|'''list''']].
}}{{TableRowN| ''<parent>'' | schedule | Array of Objects | The schedule 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>'' | schedule | Required | Array of Objects | The schedule object
}}{{TableRowN| schedule | schedule_id | Optional | Integer | ID for schedule
}}{{TableRowN| schedule | timerange | Optional | Array of Objects | (See [[Sensaphone.net API/timerange|Sensaphone.net API/timerange]])
}}{{TableEnd}}

====Example JSON====
Retrieve schedule information.

*'''Request JSON'''

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

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

===POST===
'''URI Mode Request URI's:'''
*Create a new (default) schedule.
'''POST''' <nowiki>https://</nowiki>rest.sensaphone.net/api/v1/{ACCTID}/{SESSIONID}/user/{USER_ID}/contact/{CONTACT_ID}/schedule

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

'''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 "schedule" resource, if any. See the [[Sensaphone.net_API#List|'''list''']].
}}{{TableRowN| ''<parent>'' | schedule | Array of Objects | The schedule object
}}{{TableRowN| schedule | timerange | Array of Objects | Optional (See [[Sensaphone.net API/timerange|Sensaphone.net API/timerange]])
}}{{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>'' | schedule | Required | Array of Objects | The schedule object
}}{{TableRowN| schedule | schedule_id | Optional | Integer | ID for schedule
}}{{TableRowN| schedule | timerange | Optional | Array of Objects | (See [[Sensaphone.net API/timerange|Sensaphone.net API/timerange]])
}}{{TableEnd}}

===DELETE===
'''URI Mode Request URI's:'''
*Delete an existing schedule. This may make it go away or reset it to default values, depending on the context.
'''DELETE''' <nowiki>https://</nowiki>rest.sensaphone.net/api/v1/{ACCTID}/{SESSIONID}/user/{USER_ID}/contact/{CONTACT_ID}/schedule/{SCHEDULE_ID}

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

'''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 "schedule" resource, if any. See the [[Sensaphone.net_API#List|'''list''']].
}}{{TableRowN| ''<parent>'' | schedule | Array of Objects | The schedule object
}}{{TableRowN| schedule | schedule_id | Integer | The ID of the schedule
}}{{TableEnd}}

@@ Line 22: / Line 22: @@
 }}{{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 "schedule" resource, if any. See the [[Sensaphone.net_API#List|'''list''']].
@@ Line 107: / Line 107: @@
 }}{{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 "schedule" resource, if any. See the [[Sensaphone.net_API#List|'''list''']].
@@ Line 135: / Line 135: @@
 }}{{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 "schedule" resource, if any. See the [[Sensaphone.net_API#List|'''list''']].

@@ Line 44: / Line 44: @@
+    {
       "acctid": 987654,
-      "uuid": "0123-4567-8901",
+      "session": "0123-4567-8901",
       "request_type": "read",
       "device":[