MobileTrack Nexus Documentation
Mobile
Contains data structures for small items, like a PhoneNumber or a GeoLocation.
Classes
| AccountDto |
Represents a human being who is a user on the portal. A user can sign-in and perform actions in the MobileTrack portal based on their permissions scope.
For more information, visit
.
The documentation website outlines what an account is, what it is allowed to do, what the valid states are and how state affects behavior. |
| ApiResultModelT | Any and all calls to the server that do not result a page must return this model instead. Using the StatusCode field, the end application will know how to execute the payload. |
| ApiTokenDto | Represents an API token for third party/mobile usage |
| BlobDto | Blob file (file, video, attachment, etc.) on Azure storage |
| BusinessObjectDto | Represents a simple ID/Label object for JSON serialization, to compare objects while ignoring their type. |
| BusinessSegmentDto | Represents a simple ID/Label object for JSON serialization; useful for dropdowns to allow users to specify items from a large list without having it impact performance and RAM usage significantly. |
| CompanyDto |
Represents a customer of MobileTrack. A company can be an organization, a business, or a private person. It can also be a business which has multiple B2B customers for whom they provide services. Those B2B customers are not represented as individual CompanyDto's, but can be organised as EnvironmentDto's within the company. |
| DeletedItem | Represents an item that has been deleted. This is a reference to said deleted item, in case a user or process tries to access the deleted item. |
| DeviceDto | Interface for a device, whether it be a phone, beacon, tracker or a smart fridge. |
| DeviceEndPoint | Represents an endpoint a DeviceDto can connect to as a receiver. |
| DeviceMessageDto | Interface for a message send by a device, after it has been parsed. |
| DevicePayloadDto | Represents a Payload sent from a device to the receiver, containing event and telemetry data. |
| DeviceSettingValueT | Represents a setting property value on a DeviceDto, e.g. "low battery threshold" or "authorized number(s)". |
| EncryptedPasswordDto | Encrypted password |
| EnvironmentDto | Describes an EnvironmentDto in MobileTrack: this can be a whole CompanyDto, or a location within a CompanyDto, or a department within that EnvironmentDto, etc. |
| FileDto | Represents a file, usually one uploaded by a user (image, excel sheet, etc) |
| FilterItem | Filter settings for Grids and other collection constructs. |
| FreeFieldLabels |
Represents a list of labels that a CompanyDto can apply to their IFreeFields. For example, they can have a list of labels for free fields of AccountDtos, EnvironmentDtos, DeviceDtos, etc. |
| GeofenceDto |
A virtual geographic boundary, defined by GPS or RFID technology,
that enables software to trigger a response when a mobile device enters or exits the specified area. For our use case, we apply these objects to DeviceDto and EnvironmentDto objects using the IHasGeofences interface. |
| GeofenceReferenceDto | Geofence reference DTO (GeofenceDto with the reference to the parent EnvironmentDto or DeviceDto). |
| HeartbeatDto | Heartbeat status from a third party endpoint. |
| ImageReference | Represents a reference to an image that can be used by the Business object to identify itself; an AccountDto avatar, DeviceDto icon on Google Maps, etc. |
| IpAddressStatusDto | Represents the status of an IP address, whether it is on the whitelist or blacklist (as defined by Allowed). The Label property is the IP address. |
| IpLookupJsonModel | Represents the returns of https://ipapi.co/{IpAddress}/json/. See https://ipapi.co/api/#complete-location for more information. |
| Iso3166 |
Country lookup list to determine the locale for PhoneNumbers, AccountDtos, etc. (System.Globalization does not contain everything we need) We follow the standards set by the International Organization for Standardization (ISO) in ISO 3166-1. See https://www.iso.org/iso-3166-country-codes.html for more information. |
| Iso3166Country |
Representation of an ISO3166-1 Country. Refer to the Glossary for ISO 3166 for more information. |
| KmlDto | Represents a KML object |
| KmlPlacemark | Represents an object to place on Google Maps (lines, icon, etc.) |
| KmlStyle | Kml stylesheet for objects (lines, PoI's, etc.) |
| LineStyleMapping | Line style of a KML map (for when a line will be drawn on the map) |
| LogDto | Represents a log from a user or automated system. |
| MapMarkerDto | Represents an object on the map (e.g. a point of interest, a line, a geofence, etc.) |
| MfaConnectionDto | Represents an MFA connection |
| MobileTrackDefaultCompany | Contains read-only data, so we can assign MobileTrack support users to a default company and environment. |
| MobileTrackEventIds | When logging with the ILogger, use any of the ids below to denote your event |
| NotificationDto | Interface for a notification for a request to be sent to a user. |
| RequestDto | AccountDto user created request to get an action performed |
| RoleAssignmentDto | Represents a role assignment, where a RoleDto is assigned to a AccountDto for scope ScopeId |
| RoleDto | Represents a Role that can be applied to users. Some roles are global, some are created and bound to a company. |
| SettingsDto |
A settings model that determines the look and feel of the portal for a particular CompanyDto, EnvironmentDto or AccountDto. Note: the Id of this object is the object it is applied to. Note: style sheet elements in this class references controls made in Figma |
| SortingItem | Item describes one sorting criteria. |
| UnauthorizedAccessModel | Dataset invoked when a user attempts to enact an action they're not allowed to do. This is a last-resort failsafe, indicating a potential code issue and/or a hacking attempt. |
Structures
| GeoLocation | Structure representing a point on the map. This can, for example, be a device Fix emitted by a DeviceDto to the receiver, or a static point where the user decides an object is (like an EnvironmentDto). |
| GeoLocationWithHeading | Structure representing a Gps Fix emitted by a DeviceDto in a message, including where the object appears to be headed and at what speed. |
| ImeiNumber | IMEI number for a DeviceDto to identify with. |
| MacAddress | A MAC (Media Access Control) address, sometimes referred to as a hardware or physical address, is a unique, 12-character alphanumeric attribute that is used to identify individual electronic devices on a network. If set, the address must follow the following hexadecimal pattern like so: 00-B0-D0-63-C2-26 |
| NumberRange | Provides the minimum and maximum values of a number range. |
| PhoneNumber | Represents a phone number of a user. |
| SimCardNumber | Refers to a SIM ICCID (Integrated Circuit Card Identifier) used by a DeviceDto. |
| SolarKIndexStatus |
Derived from https://services.swpc.noaa.gov/json/planetary_k_index_1m.json. It contains the effects of the sun on the magnetosphere of the last few hours and the predictions for the coming hours. The K-index, and by extension the Planetary K-index, are used to characterize the magnitude of geomagnetic storms. Kp is an excellent indicator of disturbances in the Earth's magnetic field and is used by the American Space Weather Prediction Center (SPWC) to decide whether geomagnetic alerts and warnings need to be issued for users who are affected by these disturbances. GPS Satellites can be affected by these disturbances, so it is important to monitor the Kp index. |
| ValidationModel | Represents information returned when an attempt to validate a model was made. |