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.
DeviceCommandHistory
Represents a paginated response containing the command history for a device.
DeviceShare
A device share represents the sharing of streaming data from a device into multiple databases. A database which is the primary device subscriber may share the data with one or many other databases.
Important Legal and Cost Considerations:
- Legal and cost implications: Data sharing carries legal and potential cost implications for both parties
- Authorization required: All participants must be authorized to act on behalf of their respective organizations to establish the integration for the purposes of sharing data to or receiving data from other databases
- Fees may apply: Consult your reseller or account manager before proceeding
- Termination rights: Either party may terminate the share at any time by removing the DeviceShare entity
- Acknowledgment: Programmatic invocation of the Add or Set API methods constitutes explicit acknowledgment of these terms on behalf of the caller's organization and is recorded in the system audit log
**Legal Disclaimer - Creating a Data Share:**
By enabling the sharing of this data, I confirm I am authorized to share this device data on behalf of my organization. Fees may apply. This share can be terminated anytime.
**Legal Disclaimer - Accepting an Incoming Data Share:**
Another Geotab user wants to share device data with your database. If you accept:
- Your database will get access to telematics data for the shared device(s).
- Fees may apply, depending on your agreement. Check with your reseller or account manager before you accept.
- Either party can stop the share at any time
- By accepting, you confirm you're authorized to receive this data for your organization.
**Consent and Audit Logging:**
Any programmatic activation of data sharing endpoints (Add, Set) acts as an execution of implied consent and will be tracked automatically via the system transactional audit log.
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.
EmissionComplianceEvent
Represents a significant event in the compliance timeline of a vehicle's Clean Truck Check (CTC) enrollment.
This entity logs key milestones, such as the initial enrollment, scheduled compliance actions, report submissions to the Californian Air Resources Board (CARB), and the resulting compliance status feedback.
Security clearance requirements:
- Creating/Updating (Add/Set requests) for EmissionComplianceEvent are not available to API users.
- Retrieving (Get requests) requires one of the following clearances: AccessCleanTruckCheckCompliance, AccessCleanTruckCheckComplianceEditor, or AccessCleanTruckCheckComplianceViewer.
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.
ExceptionEvent
The event of an exception generated by Rule violation.
**Important Note on Date Range Searches:** When you search for events using a fromDate and toDate, the API returns all events that were active at any point during your search period. This is the intended behavior.
Specifically, an event is returned if:
- It starts and ends within your specified time frame.
- It started **before** your
fromDate but ends within your time frame. - It starts within your time frame but ends **after** your
toDate. - It started **before** your
fromDate and ends **after** your toDate, overlapping the entire period.
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
- 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.
MimeContent
The contents of a TextMessage containing data to give to a IOX Add-On over an RS232. It holds more data than SerialIoxContent and is not compatible with all Add-Ons. For more information regarding Add-On compatible please contact your reseller. MimeContent is converted into bytes with a specific format. The first byte is the length of the MimeType (N). The next N bytes are the ASCII encoded bytes of the MimeType string. The next two bytes are the length of the Data (L). Finally, the next L bytes are the Data. Messages from MyGeotab will be delivered in this format and messages to MyGeotab must be in this format as well.
MimeContentBase
The contents of a TextMessage containing data to give to a IOX Add-On over an RS232. It holds more data than SerialIoxContent and is not compatible with all Add-Ons. For more information regarding Add-On compatible please contact your reseller. MimeContent is converted into bytes with a specific format. The first byte is the length of the MimeType (N). The next N bytes are the ASCII encoded bytes of the MimeType string. The next two bytes are the length of the Data (L). Finally, the next L bytes are the Data. Messages from MyGeotab will be delivered in this format and messages to MyGeotab must be in this format as well.
PostedRoadSpeedOptions
Defines options for a posted road speed request.
SerialIoxContent
The contents of a TextMessage containing data to give to a third-party IOX Add-On over an RS232. The SerialIoxContent is a 'dumb pipe' type of message. Whatever data is put in the data property will be delivered, as is, to the system on the other end of the IOX-RS232.
ShipmentLog
A ShipmentLog is a record of shipment transported by a specified vehicle for a duration of time.
**Important Note on Date Range Searches:** When you search for events using a fromDate and toDate, the API returns all events that were active at any point during your search period. This is the intended behavior.
Specifically, an event is returned if:
- It starts and ends within your specified time frame.
- It started **before** your
fromDate but ends within your time frame. - It starts within your time frame but ends **after** your
toDate. - It started **before** your
fromDate and ends **after** your toDate, overlapping the entire period.
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.
Zone
Sometimes referred to as a "Geofence", a zone is a virtual geographic boundary, defined by its points representing a real-world geographic area.
Note: When adding, updating, or removing multiple zones in bulk, issue Add, Set, and Remove calls one at a time rather than concurrently. Concurrent operations may result in a retryable error.