Skip to main content

Location history object with comprehensive tracking and administrative details

ā€‹
_id
string

Unique identifier for the location history entry

Example:

"634e98098ce07d29474a7e22_example@mile.app_1675224349343"

ā€‹
organizationId
string

Unique identifier for the organization

Example:

"634e98098ce07d29474a7e22"

ā€‹
email
string

User's email assigned to the monitored task

Example:

"example@mile.app"

ā€‹
taskId
string

Unique ID to identify the task

Example:

"634e98098ce69d29474a7e11"

ā€‹
lat
number

Latitude coordinate position

Example:

-6.1771046

ā€‹
lon
number

Longitude coordinate position

Example:

106.9240199

ā€‹
speed
integer

Vehicle speed in kilometers per hour

Example:

40

ā€‹
distance
integer

Distance traveled from the previous location

Example:

50

ā€‹
distanceToDest
number

Distance estimated from the next location

Example:

120.5

ā€‹
duration
integer

Time duration spent at this location in milliseconds

Example:

50

ā€‹
time
integer

A timestamp indicating the time of the location history entry

Example:

1675224349343

ā€‹
createdTime
string

Time at which the location history was created

Example:

"2022-10-07 03:00:58"

ā€‹
updatedTime
string

Time at which the location history entry was last updated

Example:

"2022-10-07 04:00:58"

ā€‹
eventName
string

A flagging of location history with value otw, nearBy and done

Example:

"otw"

ā€‹
isLatest
boolean

Identifier for flagging the latest location history

Example:

true

ā€‹
createdFrom
string

A flagging for describe location history created from, default value generated by system is mileAppField

Example:

"GPS"

ā€‹
updatedBy
string

Email of the user who last updated the location history entry

Example:

"admin@mile.app"

ā€‹
createdBy
string

Email of the user who created the location history entry

Example:

"field@mile.app"

ā€‹
startTime
string

Time at which the start working was created. Include this payload when starting work

Example:

"2022-10-07 03:00:58"

ā€‹
finishTime
string

Time at which the finish working was created. Include this payload when finishing work

Example:

"2022-10-07 05:00:58"

ā€‹
notes
string

Field for written records used to capture and retain important information

Example:

"Task completed successfully"

ā€‹
data
object

This is a free object that you can fill with any data in object format

Example:
{
  "temperature": 31,
  "anotherKey": "anotherValue"
}
ā€‹
finish
object

Contains object data when the user has finished working

ā€‹
trackedTime
number

Time tracked from start to finish in minutes

Example:

60

ā€‹
deletedTime
string

Time at which the location history was deleted

Example:

"2022-10-07 06:00:58"

ā€‹
isDeleted
boolean

Soft delete flag indicating if location history is deleted

Example:

false

ā€‹
metadata
object

Additional metadata for internal system use

ā€‹
failedCode
enum<string>

Location History Module business failedCode that indicate specific failure conditions or business rule violations during location history module operations. These codes help identify the failed operation of location history-related and provide standardized failure identification across the system.

Possible values:

  • lochi-032: Invalid state/condition - Location history state invalid
  • lochi-033: Location history not found - Location history does not exist
  • lochi-035: Access forbidden - User lacks location history permission
  • lochi-040: Limit exceeded - Location history limit exceeded
  • lochi-045: Server failure - Internal server failure
Available options:
lochi-032,
lochi-033,
lochi-035,
lochi-040,
lochi-045