Loading...

Operations and results

GetLocation


This operation allows us to obtain the locations of a device in a range of dates

Endpoint http://api.plaspy.com/api/GetLocation
Request
Variable Type Description
Account string Account name to connect
ApiKey string API key generated in point Activation API.
IdDevice string Device identifier normally consult the IMEI.
StartUTC dateTime Date from which consultation is required in UTC. (Default: current date -1 hour)
EndUTC dateTime Date until which the consultation is required in UTC. (Default: Current date)
LastLocation boolean True when only the last position of the device is required in the date range. In true only it returns more than 1 result in false returns all positions of the date range. (Default: true)

Response
The result of this operation is a list of an object with the following variables

Array Of PLocation
Variable Type Description
DateTime dateTime Date on which the location of the device is made.
Latitude double Latitude in degrees
Longitude double Longitude in degrees
Speed double Speed in meters / second if available.
Course double Horizontal direction if available in a range of 0 to 360 where 360 is the north.
Battery int percentage of the device's battery is not available.
Fuel int The Fuel level percentage
Temperature int The temperature in Celsius degrees
SensorTime1 long Elapsed time from sensor 1 is active
SensorTime2 long Elapsed time from sensor 2 is active
SensorTime3 long Elapsed time from sensor 3 is active
SensorTime4 long Elapsed time from sensor 4 is active
InactiveSeconds int Elapsed time from no movement
RPM int Revolutions per minute
Milleage double Mileage in kilometers (Km)
Attributes object Additional attributes



GetAlert


Operation to get all alerts from one device in a Date Time range

Endpoint http://api.plaspy.com/api/GetAlert
Parameters
Variable Type Description
Account string Account name to connect
ApiKey string API key generated in point Activation API.
IdDevice string Device identifier normally consult the IMEI.
StartUTC dateTime Date from which consultation is required in UTC. (Default: current date -1 hour)
EndUTC dateTime Date until which the consultation is required in UTC. (Default: Current date)
LastAlert boolean True when only the last alert of the device is required in the date range. In true only it returns more than 1 result in false returns all positions of the date range. (Default: true)
AlertName string Alert filter by type, by default return all alerts

Response

The result from this operation is an array of the next variables

Array Of PAlert
Variable Type Description
DateTime dateTime Alert date time
Latitude double Alert Latitude
Longitude double Alert Longitude
Text string Alert text
Email bool true if the alert was notified by email
SMS bool true if the alert was notified by SMS
Alerts string array An array of type of alert triggered