This is the primary method used to sync data from the MyGeotab system for example all the GPS positions. The following entities are currently supported and must be set in the typeName.
See User (including Driver) *search not supported. Maximum results: 5,000.
See Zone *search not supported. Maximum results: 10,000.
This call is designed to allow incremental updates by returning a FeedResult which contains the last version from the set of data returned. This return version is then used as the fromVersion argument for the next call. This guarantees that no changes in the data can be missed and that all data is consistently returned. It is important to understand that this feed call only returns changes in the data; so that at least one change must be received, otherwise the state is considered unknown. This call would typically be made every minute or more, to keep the data near real-time and up to date. Provide search parameters to limit the scope of the data being returned. In some rare circumstances old data in the system can be modified. If this happens, that old data is resent (with the changes) as it will have a newer version. In your design you must consider this.
It may be required to provide an entity search using from date to "back-fill" or "seed" data from a date in the past. Providing a from date guarantees that the feed will start at a version with all entities that have a date greater than or equal to the date provided. However, it is possible that the feed will return entities before the provided date. Searching using from date should be used independent of fromVersion and only on the first request.
Last retrieved version. All new data that has arrived after this version will be returned in this call, up to a maximum of resultsLimit data records. The FeedResult returned by the feed method will contain the highest version for subsequent calls. When starting a new feed, if this value is not provided, the call will return only the toVersion (last version in the system). The start date can be specified in the search argument.
propertySelector
The PropertySelector used to limit the Entity properties retrieved from the server. >> Beta: not supported by all types.
resultsLimit
The maximum number of records to return. The maximum value is 50,000 unless otherwise stated above, such as for User, Route, etc. If resultsLimit is not specified, the maximum value is used by default.
search
The search object for the type of data to return. The properties of this object will be used to filter returned data. Providing a search parameter can have performance implications similar to using the Get method. See the type related search objects for more details.
typeName
Identifies the type of entity that is being passed to the next parameter. For example, Device.
Return value
A FeedResult containing a list of all available data and the last version in the set returned by this call.