UserSession Json Schema

In This Topic

Description

Represents a comprehensive UserSession record within the OnTime API.

Overview

UserSession

Represents a comprehensive UserSession record within the OnTime API.

Vehicle : string

The unique Guid identifier referencing the Vehicle operated by the User for the duration of this UserSession.

ID : string

The unique identifier for this UserSession record.

UserID : string

The unique Guid identifier referencing the relative User record assigned to this UserSession.

LogInType : string

Determines if the User is logged-in as a dispatcher or driver for the duration of this UserSession. Available Values: [Undefined, Dispatcher, Driver]

LogInTime : string

The date and time that the User had logged-out.

LogOutTime : string

The date and time that the User had logged-out.

StartMileage : integer

The initial odometer reading of the Vehicle when the User logged-in as a driver.

EndMileage : integer

The final odometer reading of the Vehicle when the User logged-out as a driver.

Properties

Name	Description	Data Type
Vehicle	The unique Guid identifier referencing the Vehicle operated by the User for the duration of this UserSession.	string
ID	The unique identifier for this UserSession record.	string
UserID	The unique Guid identifier referencing the relative User record assigned to this UserSession.	string
LogInType	Determines if the User is logged-in as a dispatcher or driver for the duration of this UserSession. Available Values: [Undefined, Dispatcher, Driver]	string
LogInTime	The date and time that the User had logged-out.	string
LogOutTime	The date and time that the User had logged-out.	string
StartMileage	The initial odometer reading of the Vehicle when the User logged-in as a driver.	integer
EndMileage	The final odometer reading of the Vehicle when the User logged-out as a driver.	integer