MyWakes Web API REST Reference summary
actions
A MyWakes' action can be a mail, an SMS, a voice call or a web post or get, or all of these. With these endpoints it is possible to manage actions and also raise them.
When an action is raised MyWakes performs the tasks set. After that, the action become an alarm and it is saved into Alarms table in an unread state.
You can query alarms using Query interface and then you can use Action interface to set some alarm as read.
brands
Link brands to your assets and manage them.
Thanks to external reference field you can easily synchronize third party software with MyWakes cloud platform.
charts
A geographic map can be overlaid on the Google map display. You must enter the geographic coordinates of the chart limits.
While viewing the map, in the endpoints that returns iframes, you can overlay dynamically a chart by choosing it from the charts list. You can set also the transparency factor.
consumers
A consumer is a vehicle or a pet or a person or any other entity that can be associated to a tracking device. MyWakes permits to associate devices and consumers in a one-to-one correspondence.
These endpoints permit to manage almost every feature about consumers.
consumerstypes
When looking at map, especially in radar map, can be very useful doing search for consumers types.
This permits, for esample, to retrieve only trucks or only cars and so on.
devices
MyWakes permits to interact directly with devices retrieving and modifying settings and working parameters. It is possible to enable a new device for a specific user account and then load devices data, modify them and apply new settings.
drivers
MyWakes permits to creates drivers, manage driving license data along with other information.
It is also possible to associate authentication methods, such as RFID card or iButton, to drivers.
This permits to register driving hours and to recognize drivers when starting vehicle engine so only enabled drivers will be able to do this.
geofences
Create and manage your virtual fences and their alarm modes.
A "Virtual Fence" (geo-fence) defines a geographical area to be controlled, the boundaries of which exceeded, the system is able to generate an alarm message.
You can choose whether the crossing of the border should be reported incoming, outgoing or both. You can also select the delay time after which, if the instrument does not come back out (or in) the controlled area, the state of alert triggered by the instrument has to become a real alarm and then be sent to the recipients.
The GPS positions notified by the devices or by the endpoint "/api/{version}/tracks/points" will come to the system. The activated virtual fences, automatically raise related actions, if the boundaries of the fences will be crossed.
groups
Use groups to filter consumers according to your needs.
Thanks to external reference field you can easily synchronize third party software with MyWakes cloud platform.
kmls
One or more Kml / Kmz / GeoRSS files can be overlaid on the Google map display. You can set a file to always be overlaid automatically.
While viewing the map, in the endpoints that returns iframes, you can overlay dynamically one or more Kml / Kmz / GeoRSS files by choosing them from the layers list.
models
Create and manage models, associate the model to its brand and link each model to its own consumer.
Thanks to external reference field you can easily synchronize third party software with MyWakes cloud platform.
mywakesui
Include any pages of the reserved area such as Iframe in your pages.
You can also customize the look by editing the page's CSS.
ownershiptypes
Create and manage ownership type like Buying Outright, Leasing, Personal Contract Purchase.
Thanks to external reference field you can easily synchronize third party software with MyWakes cloud platform.
pois
Points of interest can be overlaid on the Google map display.
While viewing the map, in the endpoints that returns iframes, you can overlay dynamically the points of interest by choosing them from the layers list. You can set the "loadUserWpt" in the User to always be overlaid automatically the POIs.
query
MyWakes offers to developer a powerful tool that makes any authorized application able to perform any query against MyWakes platform also if it is not included in all other interfaces endpoints.
reports
You can download several reports in PDF format. You have a overview of the tracks with driving and break times, list of devices with battery state, virtual fences summary and more.
shop
The Shop controller permits to prepare a shopping cart to renew MyWakes tracking devices and buy both text messages and voice calls.
After that the user can be redirected to the shopping web site in order to continue with shopping or proceed with the payment.
suppliers
Create and manage suppliers data keeping you company address book and contacts updated thanks to external reference field.
You can easily synchronize third party software with MyWakes cloud platform.
tracks
These endpoints permit to start and stop tracks, add points and query tracks data in any way users may need.
Note: each consumer can have only one active track at a time.
Automatic closing service
When a track remains opened for 24 hours without receiving any point, MyWakes will close this track automatically and the closing time will be the last received point's time.
MyWakes will record when a track has been automatically closed by the server.
users
MyWakes permits to authorized Applications to create users. These users will be forever associated with their “Created Application” and can be queried by specifying the username parameter in the commands that require it.
utilities
You can find in this section several features with calculations of positions, timezone conversions, and several interesting utilities.
The calculations include checks whether a given point falls within an area, POIs closest to a location and more.
Direction means relative to true north and orthodromic.