Verayu


Documentation

Complete API reference

Welcome to the API reference section of Verayu LaasAPI. This document has been arranged in such a way that each method is added to it's relevant section.

Zone Related Functions

Method Description
addzone This method allows you to add a zone to your account
getzones This method returns all the zones added to your account
deletezone This method removes a zone and all the trackees and data assoicated with it

Trackee Related Functions

Method Description
addtrackee / addresource This method allows to add a trackee to your account, this action requires to have an already added zone (refere addzone API method to understand how to add a zone
updatetrackeename / updateresourcename This method allows to update the name of the trackee / resource
updatetrackeemobile / updateresourcemobile This method allows to update the mobile number of a trackee / resource
updatetrackeezone / updateresourcezone This method allows to move a trackee / resource from one zone to another
updatetrackeedriver This method allows to update the mobile number of the driver for communication purpose
deletetrackee / deleteresource This method allows to remove a trackee / resource from your account. This also wipes the entire history of the trackee.
gettrackeesbyzone This method allows to retrieve all the trackees of a given zone.
getnearbytrackees This method returns all the trackees nearby to a location.
gettrackeedetail This method returns all the details about a given trackee
setresourceimei This methods allows you to set an imei against a given trackee

Scheduling

Method Description
starttrip This method allows you to start a trip against a trackee
canceltrip This method allows you to cancel a scheduled trip (if it has not already started)
stoptrip This method allows you to stop a running trip
changeupdatefrequency This method allows you to change the update frequency of the on-going trip
initiatetrip This method allows you to associate a route to the ongoing trip.
createshift This method allows you to create a shift for the purpose of bulk scheduling
getshifts This method returns all the shifts created by the current customer
schedulezonetrips This method allows you to create schedule for all the trackees in a zone
scheduletrackeetrips This method allows you to create schedule for an individual trackee
gettrackeeschedule This method allows you to get all the schedules of a given trackee
canceltrackeeschedules This method allows you to cancel and re-arrange (automatic) the schedule for a given trackee

Location Info

Method Description
getlastknownlocation This method returns the last known locations of the given trackee / all trackees (default all trackees)
getincrementallocation This method returns the last known locations of the given trackee / all (trackees, default), but in incremental way
gettripreport This method returns the report of a given trip against the start and end time parameters
changeupdatefrequency This method allows you to change the update frequency of the on-going trip
geocode This method allows you to get the location (latitude and longitude) based on address
addresstogeofence

This method allows you to resolve a location to a given polygon group

 

Route functions

Method Description
uploadroute This method allows you to upload a reoute file (in the prescribed format) to the server
deleteroute This method allows you to delete a given route
getroutes This method returns all the uploaded / created routes

Routing and Roastering

Method Description
route This method allows you to send data for shift routing
getroutingoutput Will give you the routing output whenever it is ready
updatetravelertsettings To set the travelert related settings

Callbacks

Method Description
setcallbackurl This method allows yout to setup callback url to receive data from server (refer what data will I get from Verayu LaaS API)
getcallbackurl The method will return the callback url that you have already set