Add (...)

Adds a new Entity to the database. This method is used to add the different entities to the database, for example Device, User or Zone. In addition to the credentials, the method will require a minimum of two parameters - the type of entity that is being added (typeName) and the entity itself. In most cases, the entity being added will need to be fully constructed. In other words, all its properties need to be defined. These requirements are defined in each of the entity definitions below.

Authenticate (...)

Authenticates a user and provides a LoginResult if successful. The authentication pattern is documented in the Concepts sections of the SDK.

Throws:

• InvalidUserException
• DbUnavailableException
• OverLimitException

CreateDatabase (...)

Creates new uniquely named database on a server in the federation. Requires either a valid CaptchaAnswer and/or valid MyAdmin user credentials. See https://github.com/Geotab/sample-registration for an example.

EmissionEnrollDevices (...)

Enrolls devices for Clean Truck Check emission reporting.

Requires the AccessCleanTruckCheckCompliance security clearance.

GenerateCaptcha (...)

Generates a single use CAPTCHA image for the given key and serves the result as "image/png" content.

Get (...)

Gets the Entity(s) for the given entityType. This method can be used in various ways to return all, one or some specific set of data for the Entity(s).

GetAddresses (...)

Gets addresses from the list of Coordinate(s), as well as any Zones in the system that contain the given coordinates.

GetCoordinates (...)

Geocodes or looks up the latitude and longitude from a list of addresses.

GetCountOf (...)

Gets the count of the specified Entity type from the database. Entities that are currently inactive (the Entity's ActiveTo date is before the current time) are counted as well.

GetDaylightSavingRules (...)

Get a Timezone's TimeZoneInfoWithRules by the timeZoneId.

GetDirections (...)

Gets step-by-step driving Directions for a sequence of Waypoints including estimate travel time and distances.

GetEmissionComplianceDeadline (...)

Gets the Clean Check Truck compliance enrollment status including the next compliance deadline for a device.

Requires one of the following security clearances: AccessCleanTruckCheckCompliance, AccessCleanTruckCheckComplianceEditor or AccessCleanTruckCheckComplianceViewer.

GetFeed (...)

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 AnnotationLog and AnnotationLogSearch for Annotation Log related parameters.

See Audit and AuditSearch to provide a fromDate from which to seed the feed.

See ChargeEvent and ChargeEventSearch for Charge Event related parameters.

See CustomData and CustomDataSearch for Custom Data related parameters.

See DebugData and DebugDataSearch for Debug Data related parameters.

See Device *search not supported. Maximum results: 5,000.

See DeviceShare *search not supported.

See DeviceStatusInfo *search not supported.

See Diagnostic *search not supported.

See DriverChange and DriverChangeSearch to provide a fromDate from which to seed the feed.

See DutyStatusLog and DutyStatusLogSearch for Duty Status Log related parameters.

See DVIRLog and DVIRLogSearch for DVIR Log related parameters.

See ExceptionEvent and ExceptionEventSearch for Exception Event related parameters.

See FailureMode *search not supported.

See FaultData and FaultDataSearch for Fault Data related parameters.

See FillUp and FillUpSearch for Fill Up related parameters. Maximum results: 10,000.

See FuelTaxDetail and FuelTaxDetailSearch for Fuel Tax Detail related parameters.

See FuelUsed and FuelUsedSearch for Fuel Used related parameters.

See FuelAndEnergyUsed and FuelAndEnergyUsedSearch for Fuel and Energy Used related parameters.

See IoxAddOn and IoxAddOnSearch for Iox Add-On related parameters.

See LogRecord and LogRecordSearch for Log Record related parameters.

See MediaFile *search not supported. Maximum results: 10,000.

See Route and RouteSearch to provide a fromDate from which to seed the feed. Maximum results: 10,000.

See Rule (including ZoneStop ExceptionRuleBaseType) *search not supported. Maximum results: 10,000.

See ShipmentLog and ShipmentLogSearch for Shipment Log related parameters.

See StatusData *search not supported.

See TextMessage and TextMessageSearch to provide a fromDate from which to seed the feed.

See Trailer *search not supported.

See TachographDataFile and TachographDataFileSearch to provide a user, device, type or from timestamp date to seed the feed.

See TrailerAttachment and TrailerAttachmentSearch for Trailer Attachment related parameters.

See Trip and TripSearch for Trip related parameters.

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.

GetLanguages (...)

Gets all Languages as Language.

GetRegions (...)

Gets all Regions as Region.

GetSystemTimeUtc (...)

Gets system time in UTC (Coordinated Universal Time).

GetTimeZones (...)

Get a collection of TimeZoneInfo (Olson time zones).

GetVersion (...)

The version of the server.

GetVersionInformation (...)

The version information of the server.

OptimizeWaypoints (...)

Optimizes a set of Waypoint(s).

Remove (...)

Permanently removes an Entity and its associated data. The Entity object must have an Id field. Remaining fields are optional. Note: the Entity does not function as a filter.

Set (...)

Modify an Entity which is an object in the database. The id of the object must be populated.

SetUserPassword (...)

Set the User's password.