PAYT Embedded LiveView

Request:
Response:

ACTIONS

ACTION:ping

action: 'ping'
params: No parameters


Description: Test call
Notes:

ACTION:filter

action: 'filter'
params: {string}



Description: Filter the map. Accepts comma delimited list of filters
Notes: Filter vehicles based on either Registration or Description using 'includes'. If no vehicles found, will attempt an address lookup. Remove the filter by setting to an empty string

ACTION:clusterOn

action: 'clusterOn'
params: {boolean}




Description: Toggle clustering
Notes: Toggle clustering on/off. If only one vehicle selected this will have no effect

ACTION:zoom

action: 'zoom'
params: {number}





Description: Zoom the map
Notes: If keep on map is on, map may subsequently zoom out!

ACTION:keepOnMap

action: 'keepOnMap'
params: {boolean}




Description: Keep filtered vehicles in viewport
Notes: This will result in the map zoom/pan changing as the vehicles are updated

ACTION:todayOnly

action: 'todayOnly'
params: {boolean}




Description: Show only vehicles that have reported in today
Notes: If filtered vehicle has not reported in, this can result in an empty map!

ACTION:kioskMode

action: 'kioskMode'
params: {boolean}




Description: Automatically fly to each filtered vehicle (every 10 seconds)
Notes:

ACTION:showFlags

action: 'showFlags'
params: {boolean}




Description: Turn vehicle flags on/off
Notes: Not recommended if there are a lot of vehicles