Condition
Conditions model the logic that govern a Rule and can apply to many different types of data and entities. Conditions are structured in hierarchical tree. A condition's type (see ConditionType) defines the meaning of each condition in the tree and can be an operator, special operator, data or an asset. Depending on the type of condition, it can have a minimum of 0 and maximum of 1 entity properties (Device, Driver, Diagnostic, WorkTime, Zone or ZoneType) defined per condition. Operator conditions (OR, AND, >, <, ==, NOT) will not have any entity properties populated. Special Operator conditions evaluate against special types of data such as Aux data, Zones, WorkHours, etc. and may have the entity property populated and/or a child condition populated with a Data condition. Asset conditions will only have the asset entity property populated.
- Distance: Meters (m)
- Speed: Kilometers Per Hour (km/h)
- Duration: Seconds
A tree of conditions can define simple or complex rules and can be very powerful. Please take into consideration all possible consequences of a series of rules. Overly complex, poorly written or an excessive number of rules can have undesirable performance effects.
DataToComponentContent
Message that can deliver data to a component of a GO device.
ElectricEnergyEconomyUnit
Various Electric Energy Economy units Geotab supports. Currently supported units: L-e/100 km, km/L-e, kWh/100 km, Wh/km, km/kWh, MPG-e (US), MPG-e (Imp), kWh/100 miles, Wh/mile and mile/kWh.
EmissionVehicleEnrollment
A Clean Check Truck emission vehicle enrollment. One Device should only have one active enrollment with status Pending or Enrolled. Security clearance requirements:
Creating EmissionVehicleEnrollment (Add requests) requires security clearances AccessCleanTruckCheckCompliance;
Updating EmissionVehicleEnrollment (Set requests) requires one of the following security clearances AccessCleanTruckCheckCompliance or AccessCleanTruckCheckComplianceEditor;
Note: AccessCleanTruckCheckComplianceEditor is not allowed for disenrolling an enrollment.
Retrieving EmissionVehicleEnrollment (Get requests) requires one of the following security clearances AccessCleanTruckCheckCompliance, AccessCleanTruckCheckComplianceEditor or AccessCleanTruckCheckComplianceViewer.
Group
A group is one element in a hierarchical tree. Each group can have none or many children, it is the children that define the shape of the hierarchical tree. The parent is not a property of the group object and is only defined by who the group is a child of. It is necessary to know the id of the parent group when adding a new group.
There are three core Group branches used in MyGeotab. The most common are "Company Groups", company Groups are used to organize entities (Zone, User, Device, Driver and Rule) into logical groups related to the organization. A Group structure can be constructed by region, vocation, reporting or anything that makes sense to the business, this allows aggregate reports and rolling up data in a flexible way. These groups have a many to many type of relationship with the entities that are members and are not limited to one type of entity. The second type is "Security Groups", these are Groups to which User(s) are members of and can only be applied to Users. Each Group has a list of SecurityFilter(s) associated to it. Security Filters control what parts of the application/API a User has access to. The third type of group is a "Private User Group", this group is used only for scheduling reports and displaying dashboard reports for a User. This Group will only ever apply to one User and will typically be named the user's name.
There is a base structure of Groups which cannot be removed, these are considered to be "System"
Some of these groups are:
- Company Group
- Asset Information Group
- Driver Activity Group
- Security Group
- Supervisor Security Group
- View Only Security Group
- Drive User Security Group
- Private User Group
When Groups are retrieved they will always be in a flat list of groups. The hierarchically tree(s) can be reconstructed by looking at the "Children" property of each Group. The "Root" group will never be returned and is only for system use.
PostedRoadSpeedOptions
Defines options for a posted road speed request.
TextContent
The contents of a GPS Text Message. See also:.
TextMessage
A message to send or received from a device.
When working with text messages it is important to make the distinction between a "Reply" and a "Response".
- Reply: A reply is a Text Message that is a Reply to another text message. For example: A text message is sent to a device and the device replies with a text message of it's own.
- Response: A response is a predefined ("canned") response within a text message. For example: A text message is sent to a device with a number of canned responses to reply with (Yes, No, Maybe). One of those responses is selected by the driver and is the message of the Reply from the device.
TextMessageContentType
The type of the text message content.