UserAvailability Json Schema

In This Topic

Description

Represents a comprehensive UserAvailability record within the OnTime API.

Overview

UserAvailability

Represents a comprehensive UserAvailability record within the OnTime API.

ID : string

The unique identifier for this UserAvailability record.

UserID : string

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

IsAvailable : boolean

Indicates if the User is currently available as a driver.

CurrentStatus : string

A description of the User's status while they are available.

LastStatusChange : string

The date of when the most-recent availability status update was made by the User.

Latitude : number

The geographic latitude coordinate of where the most-recent availability status update was made by the User.

Longitude : number

The geographic longitude coordinate where the most-recent availability status update was made by the User.

NextAvailabilityChange : string

The approximate date of when the next availability status update will be made by the User.

Properties

Name	Description	Data Type
ID	The unique identifier for this UserAvailability record.	string
UserID	The unique Guid identifier referencing the relative User record assigned to this UserAvailability.	string
IsAvailable	Indicates if the User is currently available as a driver.	boolean
CurrentStatus	A description of the User's status while they are available.	string
LastStatusChange	The date of when the most-recent availability status update was made by the User.	string
Latitude	The geographic latitude coordinate of where the most-recent availability status update was made by the User.	number
Longitude	The geographic longitude coordinate where the most-recent availability status update was made by the User.	number
NextAvailabilityChange	The approximate date of when the next availability status update will be made by the User.	string