WebSocket Reference

HoS

In all previous versions of Fleet Freedom, the user#notify object contained a definition of a "quiet time", where all notifications would be muted from the server.  Starting with v4.5 though, that user#notify will be an array of schedule options with "active times" instead.

this is a new thing in 4.6

We are depreciating the asset.reference field and adding asset.references.

Our system is as near real-time as can be made, and that means that maintaining synchronization can be a bit complicated on the client-side.

The WebSocket now notifes all connected clients of impending upgrades and maintenance windows, and the messages can be interpretted by your code and react appropriately.

Adding, editing, and removing asset status tags and asset attributes through the WebSocket API gives a quick and easy way to change asset state and system behaviour.

When creating or editing a maintenance schedule, it is also possible to set specific odometer, engine hours, and service date values for each vehicle.

When running a report, the synchronization messages will now contain partial totals information as the report runs.  The user running the report will also always receive the final "completed" synchronization message regardless of subscription.

Previously, when sending a subscribe or unsubscribe message, the subscriptions would not be added if access was denied to any of the subscription types.  Starting today, the subscription commands will allow partial success subscriptions to be added and removed, and the response messages will contain the list of sucessful and failed subscription types.

Ever since version 4.0, we've offered two methods to received notifications for important asset events; SMS and email.  Starting in in version 4.2, we've developed a new feature to show pop-up messages while you are logged in.  We call this new feature assetAlerts.

Connecting to the WebSocket, creating a session, sending commands, and making subscriptions are at the core of the Fleet Freedom servces. This quick-start guide will walk you through some common questions and get you moving in the right direction quickly.