List Location History: list_location_history
|
Service name: list_location_history |
|
|
URL |
https://SERVER/api/?apikey=yourAPItoken&service=list_location_history &required_parameters=required_parameters [&optional_parameters=optional_parameters] |
|
Description |
Returns location history for devices. Google Android and Microsoft Windows Phone 8.1 only |
|
Parameters |
|||||
|
Post Variable |
Description |
Type |
Required |
Options |
Default |
|
Optional. Returns a description of the service. |
boolean |
no |
true |
0 |
|
|
clientid |
The id of the client for which information is to be returned. |
integer |
no |
0 |
0 |
|
siteid |
The id of the site for which information is to be returned. |
integer |
no |
0 |
0 |
|
datestart |
The start date to return information. (YEAR-MM-DD) |
string |
yes |
0 |
0 |
|
dateend |
The end date to return information. (YEAR-MM-DD) |
string |
yes |
0 |
0 |
|
Example Service Call =list_location_history |
|
https://SERVER/api/?apikey=yourAPItoken&service=list_location_history&clientid=CLIENTID&datestart=DATESTART&dateend=DATEEND |
|
Example Response |
|
<?xml version="1.0" ?> <result created="2014-05-22T10:03:16+01:00" host="SERVER" status="OK"> <items> <client> <id>1111</id> <name>TestClient</name> <site> <id>2222</id> <name>TestSite</name> <device> <id>3333</id> <name>TestDevice</name> <location> <latitude>11.111</latitude> <longitude>22.222</longitude> <accuracy>17.32</accuracy> <datetime>2014-03-26 20:33:34</datetime> <devicedatetime>2014-03-25 23:33:53</devicedatetime> </location> <location> ... </location> </device> </site> </client> </items> </result> |
|
Field Descriptions |
|||
|
Field |
Type |
Can Be Empty |
Description |
|
client / id |
integer |
no |
Unique identifier of client |
|
client / name |
string |
no |
Name of client |
|
site / id |
integer |
no |
Unique identifier of site |
|
site / name |
string |
no |
Name of site |
|
device / id |
integer |
no |
Unique identifier of device |
|
device / name |
string |
no |
Name of device |
|
device / location / latitude |
string |
no |
Location latitude |
|
device / location / longitude |
string |
no |
Location longitude |
|
device / location / accuracy |
string |
no |
Location accuracy |
|
device / location / datetime |
datetime |
no |
Server datetime |
|
device / location / devicedatetime |
datetime |
no |
Device datetime |
| Example Associated Service Calls | ||
| Parameter | Call | URL Format |
| DeviceID | list_devices_at_client |
https://SERVER/api/?apikey=yourAPItoken&service=list_devices_at_client&clientid=CLIENTID&devicetype=server |
| list_servers |
https://SERVER/api/?apikey=yourAPItoken&service=list_servers&siteid=SITEID |
|
| list_workstations |
https://SERVER/api/?apikey=yourAPItoken&service=list_workstations&siteid=SITEID |
|
| SiteID | list_sites | https://SERVER/api/?apikey=yourAPItoken&service=list_sites&clientid=CLIENTID |
| ClientID | list_clients | https://SERVER/api/?apikey=yourAPItoken&service=list_clients |