/devices/driver-overview - FleetUp API Docs

This API returns the Driver’s overall details along with the current status. The API requires Account ID and Driver ID as input parameter.

Request

Authorization

Add parameter in header

x-api-key

Example:

x-api-key: ********************

Header Params

token

string

required

Access token which was generated earlier

Body Params application/json

acctId

string

required

Account ID

driverId

string

required

Driver’s user ID

Example

{
    "acctId": "string",
    "driverId": "string"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200成功

application/json

200 response

Body

array of:

breakRequired

integer

optional

Break Needed in Minute

status

integer

optional

User current status-> 1: Off Duty, 2: Sleeper, 3: Driving, 4: On Duty (Not Driving)

shiftLimit

string

optional

Minute, – Shift Hour Left

vehicle

string

optional

If vahicle is unassigned to any driver - N/A , if driver type is main driver then -(Main) +LicenseId of driver otherwise (Co)+LicenseId of driver

violation

array [object {7}]

optional

integer

optional

ID of HOS_VIOLATION_RECORD table

userId

string

optional

User Id

type

integer

optional

1:Rule A, 2:Rule B, 3:Rule C, 4:Rule D

shortDate

integer

optional

Date with format of yyyyMMdd. (ex) '20150909'

startTime

integer

optional

Violation start time. Unit is minute

endTime

integer

optional

Violation end time. Unit is minute

flag

integer

optional

0:original triggered; 1: Auto generate

driverId

string

optional

Driver Id

driverPhone

string

optional

Driver’s phone number

cycleLimit

integer

optional

Minute, Cycle Hour Left

violationNum

integer

optional

Violation count. Number of violations

shortDate

integer

optional

Date with format of yyyyMMdd. (ex) “20150909”.

driverName

string

optional

Driver Name

driverEmail

string

optional

Driver Email ID

drivingLimit

integer

optional

Minute, Driving Hour Left

Example

[
    {
        "breakRequired": 0,
        "status": 0,
        "shiftLimit": "string",
        "vehicle": "string",
        "violation": [
            {
                "id": 0,
                "userId": "string",
                "type": 0,
                "shortDate": 0,
                "startTime": 0,
                "endTime": 0,
                "flag": 0
            }
        ],
        "driverId": "string",
        "driverPhone": "string",
        "cycleLimit": 0,
        "violationNum": 0,
        "shortDate": 0,
        "driverName": "string",
        "driverEmail": "string",
        "drivingLimit": 0
    }
]