Sensaphone.net API/coordinates - Revision history

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

2025-07-10T15:37:19Z

‎Sensaphone.net API: Update Session data type.

Tim: /* Specifications */

2015-06-19T13:01:26Z

‎Specifications

Tim: Created page with "=Sensaphone.net API= ==Specifications== The '''coordinates''' object holds latitude and longitude coordinates. It is not an individual (top-level) API resource, but is ins..."

2015-04-29T19:14:49Z

Created page with "=Sensaphone.net API= ==Specifications== The '''coordinates''' object holds latitude and longitude coordinates. It is not an individual (top-level) API resource, but is ins..."

New page

=[[Sensaphone.net API]]=
==Specifications==
The '''coordinates''' object holds latitude and longitude coordinates. It is not an individual (top-level) API resource, but is instead used in conjunction with other resources (e.g. [[Sensaphone.net API/device|devices]]).

The coordinates resource has the following properties:
{{TableStart|border_size=1
}}{{TableRowN| '''Parent Property'''|'''Property''' | '''Type''' | '''Description''' | '''Create''' | '''Delete''' | '''Read''' | '''Update'''
}}{{TableRowN| ''<parent>'' | coordinates | Object | The coordinates object. | ''' ''' | ''' ''' | '''✓''' | '''n/a'''
}}{{TableRowN| coordinates | coordinates_id | Integer | ID of the address. | ''' ''' | ''' ''' | '''✓''' | ''' '''
}}{{TableRowN| coordinates | x | Floating Point | Longitude | ''' ''' | ''' ''' | '''✓''' | '''✓'''
}}{{TableRowN| coordinates | y | Floating Point | Latitude | ''' ''' | ''' ''' | '''✓''' | '''✓'''
}}{{TableEnd}}

===GET===
'''URI Mode Request URI's:'''
*Retrieve all the coordinate data for a particular device.
'''GET''' <nowiki>https://</nowiki>rest.sensaphone.net/api/v1/{ACCTID}/{SESSIONID}/device/{DEVICE_ID}/coordinates

*Retrieve the latitude coordinate for a particular device's address.
'''GET''' <nowiki>https://</nowiki>rest.sensaphone.net/api/v1/{ACCTID}/{SESSIONID}/device/{DEVICE_ID}/coordinates/x

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

'''JSON Mode Request Properties'''
{{TableStart|border_size=1
}}{{TableRowN| '''Parent Properties''' | '''Child Properties''' | '''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 "address" resource, if any. See the [[Sensaphone.net_API#List|'''list''']].
}}{{TableRowN| ''<parent>'' | coordinates | Array of Objects | The coordinates object
}}{{TableEnd}}

'''JSON Mode Response Properties'''
{{TableStart|border_size=1
}}{{TableRowN| '''Parent Properties''' | '''Child Property''' | '''Status''' | '''Type''' | '''Description'''
}}{{TableRowN|   | ''<parent object(s)>'' | Optional | Array of Objects | The parent(s) specified in the request.
}}{{TableRowN| ''<parent>'' | coordinates | Required | Array of Objects | Address data
}}{{TableRowN| coordinates | coordinates_id | Required | Integer | ID of the address.
}}{{TableRowN| coordinates | x | Optional | String | Longitude
}}{{TableRowN| coordinates | y | Optional | String | Latitude
}}{{TableEnd}}

====Example JSON====
Receive coordinates for a device.

*'''Request JSON:'''
{
"acctid": 987654,
"sessionid": "0123-4567-8901",
"request_type": "read",
"device":[
{
"device_id": 1234,
"coordinates": null
}
}

*'''Response JSON'''
{
"result":
{
"success": true,
"code": 0,
"message": "OK"
},
"response":
{
"device":[
{
"device_id": 1234,
"coordinates":[
{
"coordinates_id": 28487,
"x": 39.868809,
"y": -75.674508
}
]
}
]
}
}

===PUT===
'''URI Mode Request URI's:'''
*Edit the coordinates's '''x''' (latitude) coordinate.
'''PUT''' https://rest.sensaphone.net/api/v1/{ACCTID}/{SEESIONID}/device/{DEVICE_ID}/coordinates/x/{LATITUDE}

'''JSON Mode Request URI:'''
'''POST''' https://rest.sensaphone.net/api/v1/device/coordinates

'''JSON Mode Request Properties'''
{{TableStart|border_size=1
}}{{TableRowN| '''Parent Properties''' | '''Child Properties''' | '''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 "address" resource, if any. See the [[Sensaphone.net_API#List|'''list''']].
}}{{TableRowN| ''<parent>'' | coordinates | Array of Objects | The coordinates object
}}{{TableRowN| coordinates | '''''CHILD PROPERTY''''' |   | Coordinate's child properties to be edited*
}}{{TableEnd}}
<nowiki>*</nowiki>One or more '''coordinates''' child properties listed below is required (other than "coordinates_id").

'''JSON Mode Response Properties'''
{{TableStart|border_size=1
}}{{TableRowN| '''Parent Properties''' | '''Child Property''' | '''Status''' | '''Type''' | '''Description'''
}}{{TableRowN|   | ''<parent object(s)>'' | Optional | Array of Objects | The parent(s) specified in the request.
}}{{TableRowN| ''<parent>'' | coordinates | Required | Array of Objects | Address data
}}{{TableRowN| coordinates | coordinates_id | Required | Integer | ID of the address.
}}{{TableRowN| coordinates | x | Optional | String | Longitude
}}{{TableRowN| coordinates | y | Optional | String | Latitude
}}{{TableEnd}}

@@ Line 28: / Line 28: @@
 }}{{TableRowN| '''Parent Properties''' | '''Child Properties''' | '''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 "address" resource, if any. See the [[Sensaphone.net_API#List|'''list''']].
@@ Line 97: / Line 97: @@
 }}{{TableRowN| '''Parent Properties''' | '''Child Properties'''   | '''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 "address" resource, if any. See the [[Sensaphone.net_API#List|'''list''']].

@@ Line 8: / Line 8: @@
 }}{{TableRowN| ''<parent>''         | coordinates    | Object         | The coordinates object.  | ''' ''' | ''' ''' | '''&#x2713;''' | '''n/a'''
 }}{{TableRowN| coordinates          | coordinates_id | Integer        | ID of the address.       | ''' ''' | ''' ''' | '''&#x2713;''' | ''' '''
-}}{{TableRowN| coordinates          | x              | Floating Point |  Longitude               | ''' ''' | ''' ''' | '''&#x2713;''' | '''&#x2713;'''
+}}{{TableRowN| coordinates          | lng              | Floating Point |  Longitude               | ''' ''' | ''' ''' | '''&#x2713;''' | '''&#x2713;'''
-}}{{TableRowN| coordinates          | y              | Floating Point | Latitude                | ''' ''' | ''' ''' | '''&#x2713;''' | '''&#x2713;'''
+}}{{TableRowN| coordinates          | lat              | Floating Point | Latitude                | ''' ''' | ''' ''' | '''&#x2713;''' | '''&#x2713;'''
 }}{{TableEnd}}
@@ Line 18: / Line 19: @@
 *Retrieve the latitude coordinate for a particular device's address.
-    '''GET''' <nowiki>https://</nowiki>rest.sensaphone.net/api/v1/{ACCTID}/{SESSIONID}/device/{DEVICE_ID}/coordinates/x
+    '''GET''' <nowiki>https://</nowiki>rest.sensaphone.net/api/v1/{ACCTID}/{SESSIONID}/device/{DEVICE_ID}/coordinates/lat
 '''JSON Mode Request URI:'''
@@ Line 39: / Line 40: @@
 }}{{TableRowN| ''<parent>''              | coordinates             | Required     | Array of Objects | Address data
 }}{{TableRowN| coordinates               | coordinates_id          | Required     | Integer          | ID of the address.
-}}{{TableRowN| coordinates               | x                       | Optional     | String           | Longitude
+}}{{TableRowN| coordinates               | lng                       | Optional     | Floating Point           | Longitude
-}}{{TableRowN| coordinates               | y                       | Optional     | String           | Latitude
+}}{{TableRowN| coordinates               | lat                       | Optional     | Floating Point           | Latitude
 }}{{TableEnd}}
@@ Line 74: / Line 76: @@
+          {
             "coordinates_id": 28487,
-            "x": 39.868809,
+            "lat": 39.868809,
-            "y": -75.674508
+            "lng": -75.674508
+          }
+         ]
@@ Line 85: / Line 87: @@
 ===PUT===
 '''URI Mode Request URI's:'''
-*Edit the coordinates's '''x''' (latitude) coordinate.
+*Edit the coordinates's latitude coordinate.
-    '''PUT''' https://rest.sensaphone.net/api/v1/{ACCTID}/{SEESIONID}/device/{DEVICE_ID}/coordinates/x/{LATITUDE}
+    '''PUT''' https://rest.sensaphone.net/api/v1/{ACCTID}/{SEESIONID}/device/{DEVICE_ID}/coordinates/lat/{LATITUDE}
 '''JSON Mode Request URI:'''
@@ Line 109: / Line 111: @@
 }}{{TableRowN| ''<parent>''              | coordinates             | Required     | Array of Objects | Address data
 }}{{TableRowN| coordinates               | coordinates_id          | Required     | Integer          | ID of the address.
-}}{{TableRowN| coordinates               | x                       | Optional     | String           | Longitude
+}}{{TableRowN| coordinates               | lng                       | Optional     | Floating Point           | Longitude
-}}{{TableRowN| coordinates               | y                       | Optional     | String           | Latitude
+}}{{TableRowN| coordinates               | lat                       | Optional     | Floating Point           | Latitude
 }}{{TableEnd}}