page-user page-user-ken-wallen-1228 template-account-profile page-status-200 theme-harmony user-guest

Company

Title

Hi @Fabio Fabio@7gen.com​  You're getting that message because there is no object of type typeName: "SecurityClearance". A user clearance is the group identified by their security group, and the object type for it is Group as described for the second type <a href="https://developers.geotab.com/myGeotab/apiReference/objects/Group" target="_blank">here</a>. So a functional API call would be: api.call("Get", { typeName: "Group", search: { id: group.id } How that would correlate to your user.securityGroups.map I do not know. That will ONLY get you the properties for that individual group, and security groups rarely identify all their applicable security filters. The only exceptions are GroupEverythingSecurityId (has isAdd: True for "everything) and GroupNothingSecurityId (has isAdd: false for "everything"). Every other group is defined by the (cumulative) securityFilters of its parent(s), to which the securityFilters of the group itself are applied.  To know all of the securityFilters that apply to any group you must get the top level security group ("id": "GroupSecurityId"), which returns the entire security group hierarchy. Within the result (which will be thousands of lines) the security group of the user will exist, as will its parent, and that parent's parent. The entire hierarchy must be parsed to catch every securityFilter added or removed in the tree to know which securityFilters cumulatively apply to the user. Any individual group's securityFilters can only make sense within context of its parent filters. I'm not sure that any of this is ever really necessary, but it is possible and presumably would achieve what you are intending. But typically you can just make an API call as a user, and if a required securityFilter is missing then exception returned will identify it.

What MyGeotab API call must be made to check for the SecurityClearances of an add-in user?

Hi <a href="/user/development-team-1656" data-id="1656" data-value="DTeam-1656" data-denotation-char="@" class="text-decoration-none mention">@DTeam-1656</a>​  I can confirm that can happen, and using the example you provided I was able to identify your account and calls for the errors you've indicated. As you've noted, during an upgrade you'll likely get exceptions (for any call) of the type DbUnavailableException with message "DbUnavailableException: Initializing, which the .Net library is translating to "Service temporaily unavailable" as you've shown.  For Authenticate specifically it is also possible to get DbUnavailableException, but near the end of the upgrade process it may generate what you've indicated here. It appears to be a simple timing issue which will result in an InvalidUserException type exception with message: Incorrect login credentials @ ''&lt;database name&gt;".  The "@ '&lt;database name&gt;'" part of the message is significant here. If trapping for the InvalidUserException the presence of the database name in the message actually does indicate that the (existing) database is the issue. I can only identify that message variation for the exception as being returned during upgrades. Actually bad credentials to Authenticate (bad username, incorrect or invalid database name, bad password) all result in the basic "Incorrect login credentials" with no database name reference. So if trapping for handling of InvalidUserExceptions you can treat the presence of @ &lt;database name&gt; in the message the same as dbUnavailableException and just incorporate a wait period to retry the Authenticate. Thanks,Ken WallenGeotab Engineering Support

API login error during server upgrade

HI <a href="/user/claude-gilbert-1409" data-id="1409" data-value="CGilb-1409" data-denotation-char="@" class="text-decoration-none mention">@CGilb-1409</a>​  As a caveat, it is difficult to determine exactly why you might get a particular set of results for diagnosticOdometerAdjustmentId without knowing the overall status of the device at the either the time of the Get request or the search time specified in the Get request. Note that it is always valid to return diagnosticOdometerId results in a diagnosticOdometerAdjustmentId search, because every diagnosticOdometerId is itself an adjustment to diagnosticOdometerAdjustmentId. For the most part, a specific timestamp (identical to and from date) for diagnosticOdometerAdjustmentId should return:1) A diagnostic type of diagnosticOdometerAdjustmentId with a floating point value for (a) a device using GPS-only for odometer or (b) a device which is or was in a vehicle capable of reporting odometer where the timestamp correlates to 'moving' time between two diagnosticOdometerId records in the past, or after the most recent diagnosticOdometerId for a currently moving vehicle. Always true for reporting devices in currently active vehicles.2) A diagnostic type of diagnosticOdometerId with a whole number value will be returned whenever the last StatusData of that type is currently identical to diagnosticOdometerAdjustmentId (when the vehicle reported odometer is the last adjustment to the odometer and the vehicle has not moved). True for reporting devices in currently active vehicles which have been stopped with ignition off and a coinciding vehicle odometer reported in conjunction with that stop. Example: request of diagnosticOdometerAdjustmentId timestamped now for a vehicle that reported diagnosticOdometerId two days ago, result is value and diagnostic type of that diagnosticOdometerId but with the result timestamp as the time requested.3) A diagnostic type of diagnosticOdometerId with a floating value will be returned as an interpolated value for a requested time between two moving' diagnosticOdometerId in the past when that data was reported by a device no longer installed in the vehicle represented by the device id. Most likely when a Get(Device) for the id while have a serialNumber value of 000-000-0000.4) One final scenario exists when a device is not (or is no longer) reporting for the asset indicated by the id property, but an odometer adjustment has been made, probably in the user interface for that vehicle. Sometimes more than one of these adjustments can exist. For your specific Get requests here: 1) The 2022 request for device id b5 it is pretty straightforward. It's returning a value of 0 meters likely because the time precedes the activeFrom date of the device. 2) Request for device id b1 at the 2022 time returns a floating point value of 10001319.37770902 with a diagnostic type DiagnosticOdometerId. This suggests an interpolated value between two vehicle reported values for the id of an asset which no longer has that device installed (Scenario #3 above). 3) For the same device with the 2023 time a whole number value 18555555 for type diagnosticOdometerAdjustmentId suggests that the requested time is after any last reported value from the vehicle, and also after an an adjustment to diagnosticOdometerAdjustmentId for the asset (possibly after last report from device, but before device removal). Note as well that you can use GetFeed to return API adjustments to diagnosticOdometerAdjustmentId (i.e. UI changes to odometer). It will return ONLY diagnosticOdometerAdjustmentId entities with populated id and version properties. An example if you wanted to see such for your b1 device would be:  api.call("GetFeed",  {   typeName: 'StatusData',   search: {    diagnosticSearch: { id: 'DiagnosticOdometerAdjustmentId' },    deviceSearch: {id: "b1"}   },   fromVersion: "0000000000000000",   "resultsLimit": 100  }) Thanks,Ken Wallen

Querying DiagnosticOdometerAdjustmentId, but receiving DiagnosticOdometerId in some cases

The short answer is no. We haven't had any updates related to CORS since MyGeotab 8.0 and 9.0, and those specifically related retrieving HTML and JSON files for add-ins from third-party domains as described <a href="https://docs.google.com/document/d/13o4PMzIx0Pkwpxz2lYhxHbPBOgLasly6VFJmEZf1Axw/edit?usp=sharing" target="_blank">here</a>. If you've been working with JavaScript developing an add-in that's now hosted on a server with no 'Access-Control-Allow-Origin` policy defined then that could certainly cause a CORS issue when the add-in code is being retrieved. But the MyGeotab API endpoint itself should have no issue with individual API calls - CORS wouldn't really enter the picture in that case.

JS API Failing to CORS

Notification templates are associated with rules via the DistributionList entity (<a href="https://geotab.github.io/sdk/software/api/reference/#DistributionList" target="_blank">here</a>). A distribution list defines a list of recipients to receive notification when the rule specified in the distribution list entity is violated. The Recipient entity (<a href="https://geotab.github.io/sdk/software/api/reference/#Recipient" target="_blank">here</a>) would identify the recipient, the recipientType (Email, for example), and notificationBinaryFile to indicate the email template to use. You may find it easier to begin with a test rule and template in the UI in order to examine the distribution list actually created to familiarize yourself with the structures involved. Thanks,Ken

API to associate a notification template to a rule

If the location is in a zone (or zones), the zones property gets populated with an array object with those zone ids. I just made a zone around Bryan/College Station in my database to illustrate, but what your result would be I do not know.<img src="/forum/plugins/gcs-uploads/files/069Ht00000TX7VwIAL.png" alt="image" />With the zone id from the result you then just Get() the zone:<img src="/forum/plugins/gcs-uploads/files/069Ht00000TX7WGIA1.png" alt="image" />

Which API should I use to detect which Device is mapped to a Zone. I believe this is the underlying data to Zone Visits.

The Get() method exists, so the 'ensure all method parameters are included' applies. In this case you've passed the GetAddresses() method as an entity type (i.e. it doesn't exist). GetAddresses() itself is the method you want to use, defined <a href="https://geotab.github.io/sdk/software/api/reference/#GetAddresses" target="_blank">here</a>.Example and result with your coordinates (not a zone in my database):<img src="/forum/plugins/gcs-uploads/files/069Ht00000TX70aIAD.png" alt="image" />

Hi <a href="/user/arif-shareef-1716" data-id="1716" data-value="AShar-1716" data-denotation-char="@" class="text-decoration-none mention">@AShar-1716</a>​  The Geotab SDK Runner code samples include an example incorporating vehicle group change along with enabling a buzzer for speeding. Removing lines 5-7 would reduce it to just the a group change. It illustrates the basic method of a Get() of the device, modifying the companyGroups property, and making a Set() call for the change. It can be adopted and modified to fit your specific needs. https://geotab.github.io/sdk/software/api/runner.html#sample:move-vehicle-to-group-and-enable-speed-buzzing Thanks,Ken WallenGeotab Senior Solutions Engineering

API to move vehicle from one group to another group eg : we have site1, site 2 as 2 different group and vehicle1,vehicle2 currently are in group: site1 , now we want to move to site2 .

Hi <a href="/user/cliff-seiler-1810" data-id="1810" data-value="CSeil-1810" data-denotation-char="@" class="text-decoration-none mention">@CSeil-1810</a>​  There is no mapping of zones to devices as you envision. That Zone Visits page is correlating the geographical coordinates of event locations to the geographical boundaries of defined zones. The search options determine which device or driver (and timeframe) to retrieve events for. In the case of Trips, the stop location coordinates can be passed to the GetAddresses API, and the result will indicate if that location was in a zone. The device or driver would be a property of the trip, the stop location would be within a zone, but there is no direct correlation of device to zone. Zone Visits can also be determined from ExceptionEvents created based of Rules with baseType ZoneStop created for zones with the mustIdentifyStops property set to true. This is what the Zone Visits UI uses, and it requires correlation of ExceptionEvents for a device or driver in the selected timeframe, correlated to the Rules that created the exceptions, with the results filtered to exceptions only for ZoneType rules.

HI <a href="/user/arif-shareef-1716" data-id="1716" data-value="AShar-1716" data-denotation-char="@" class="text-decoration-none mention">@AShar-1716</a>​ , If you're not getting results back for that call it's because the results don't exist. DiagnosticOdometerId is a reported StatusData value from the vehicle, and it will only exist within a timeframe if it was actually reported during that time. This may be due to the device not communicating, or due to the device being unable to acquire odometer from the vehicle computer. To get the current odometer value for the vehicle as currently known to the system you can instead get DiagnosticOdometerAdjustmentId, with toDate and fromDate equal to 'now'. That is the value displayed in the MyGeotab UI. To check device communication status you can Get DeviceStatusInfo for the device and evaluate the IsCommunicating properly, along with currentStateDuration if IsCommunicating is false. Thanks,Ken

Actividad reciente