Driver Profile Service API (1.0.0)

Perform CRUD actions for driver profile.

Read driver profiles

Only VersaFleet's SysAdmin is authorized.

Authorizations:

bearerAuth

query Parameters

page	integer <int64> >= 1 Default: 1
per_page	integer <int64> >= 1 Default: 200
order	string Default: "desc" Enum: "asc" "desc" The direction of the sort
range_start_created_at	string Range start (inclusive) of Created At
range_end_created_at	string Range end (inclusive) of Created At
is_qa	boolean Is Quality Assurance
is_verified	boolean For drivers with verified date
driver_id	Array of strings Id of the drivers

Responses

Response samples

200
401
403

Content type

application/json

Example

No profiles exist

{"meta": {"page": 1,
"per_page": 200,
"total_records": 0,
"total_pages": 0,
"has_next": false,
"has_previous": false
},
"driver_profiles": [ ]
}

Read driver profiles by OrgID

Only VersaFleet's SysAdmin is authorized.

Authorizations:

bearerAuth

path Parameters

org_id

required

string

query Parameters

page	integer <int64> >= 1 Default: 1
per_page	integer <int64> >= 1 Default: 200
order	string Default: "desc" Enum: "asc" "desc" The direction of the sort
sort_by	string Default: "created_at" Enum: "name" "vehicle_plate_number" "created_at" "last_active_at" Sort field. Supported values are name, vehicle_plate_number, created_at, last_active_at
range_start_created_at	string Range start (inclusive) of Created At
range_end_created_at	string Range end (inclusive) of Created At

Responses

Response samples

200
401
403

Content type

application/json

Example

No profiles exist

{"meta": {"page": 1,
"per_page": 200,
"total_records": 0,
"total_pages": 0,
"has_next": false,
"has_previous": false
},
"driver_profiles": [ ]
}

Get single driver profile

Only VersaFleet's SysAdmin is authorized.

Authorizations:

bearerAuth

query Parameters

driver_id

string <uuid>

Responses

Response samples

200
401
403
404

Content type

application/json

{"code": "success",
"driver_profile": {"id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"name": "John Doe",
"display_name": "John",
"email": "johndoe@example.com",
"partial_id_chars": "123C",
"driver_verified_at": "2020-12-30T04:21:29.712Z",
"vehicle_plate_number": "abc4321b",
"vehicle_plate_number_proof": {"name": "proof1",
"url": "https://www.abc.com/proof1.jpg"
},
"vehicle_plate_number_verified_at": "2020-12-30T04:21:29.712Z",
"phone_number": 12345678,
"is_qa": false,
"group_tag": "tag1",
"org_id": "FreelanceDriver",
"display_picture": {"name": "pic1",
"url": "https://www.abc.com/pic1.jpg"
},
"is_available": true,
"latitude": 1.43,
"longitude": 103.222,
"version_seq": 0,
"version_rev": "0-1a2b3c4d",
"created_at": "2020-12-30T04:21:29.712Z",
"updated_at": "2020-12-30T04:21:29.712Z",
"last_active_at": "2020-12-30T04:21:29.712Z",
"last_suspended_until": "2020-12-30T04:21:29.712Z"
},
"server_time": "2020-12-30T04:21:29.712Z"
}

Update single driver profile

Only VersaFleet's SysAdmin is authorized.

Authorizations:

bearerAuth

query Parameters

driver_id

string <uuid>

Request Body schema: application/json

name	string
display_name	string
	object
vehicle_plate_number	string
partial_id_chars	string
phone_number	string
type	string Enum: "freelance" "professional"
version_rev	string

Responses

Request samples

Payload

Content type

application/json

{"name": "John Doe",
"display_name": "John",
"display_picture": {"name": "pic 1",
"url": "www.example.com/pic1.jpg"
},
"vehicle_plate_number": "ABC1234D",
"partial_id_chars": "1234A",
"phone_number": "+1234567890",
"type": "freelance",
"version_rev": "0-1a2b3c4d"
}

Response samples

200
401
403
404
409

Content type

application/json

{"code": "success",
"driver_profile": {"id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"name": "John Doe",
"display_name": "John",
"email": "johndoe@example.com",
"partial_id_chars": "123C",
"driver_verified_at": "2020-12-30T04:21:29.712Z",
"vehicle_plate_number": "abc4321b",
"vehicle_plate_number_proof": {"name": "proof1",
"url": "https://www.abc.com/proof1.jpg"
},
"vehicle_plate_number_verified_at": "2020-12-30T04:21:29.712Z",
"phone_number": 12345678,
"is_qa": false,
"group_tag": "tag1",
"org_id": "FreelanceDriver",
"display_picture": {"name": "pic1",
"url": "https://www.abc.com/pic1.jpg"
},
"is_available": true,
"latitude": 1.43,
"longitude": 103.222,
"version_seq": 0,
"version_rev": "0-1a2b3c4d",
"created_at": "2020-12-30T04:21:29.712Z",
"updated_at": "2020-12-30T04:21:29.712Z",
"last_active_at": "2020-12-30T04:21:29.712Z",
"last_suspended_until": "2020-12-30T04:21:29.712Z"
},
"server_time": "2020-12-30T04:21:29.712Z"
}

Update Is QA status

Only SysAdmin is authorized.

Authorizations:

bearerAuth

Request Body schema: application/json

is_qa	boolean
version_rev required	string

Responses

Request samples

Payload

Content type

application/json

{"is_qa": true,
"version_rev": "string"
}

Response samples

200

Content type

application/json

{"code": "string",
"message": "string"
}

Get driver profile

Only drivers are authorized.

Authorizations:

bearerAuth

Responses

Response samples

200
401
403
404

Content type

application/json

{"code": "success",
"driver_profile": {"id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"name": "John Doe",
"display_name": "John",
"email": "johndoe@example.com",
"partial_id_chars": "123C",
"driver_verified_at": "2020-12-30T04:21:29.712Z",
"vehicle_plate_number": "abc4321b",
"vehicle_plate_number_proof": {"name": "proof1",
"url": "https://www.abc.com/proof1.jpg"
},
"vehicle_plate_number_verified_at": "2020-12-30T04:21:29.712Z",
"phone_number": 12345678,
"is_qa": false,
"group_tag": "tag1",
"org_id": "FreelanceDriver",
"display_picture": {"name": "pic1",
"url": "https://www.abc.com/pic1.jpg"
},
"is_available": true,
"latitude": 1.43,
"longitude": 103.222,
"version_seq": 0,
"version_rev": "0-1a2b3c4d",
"created_at": "2020-12-30T04:21:29.712Z",
"updated_at": "2020-12-30T04:21:29.712Z",
"last_active_at": "2020-12-30T04:21:29.712Z",
"last_suspended_until": "2020-12-30T04:21:29.712Z"
},
"server_time": "2020-12-30T04:21:29.712Z"
}

Create a driver profile

Only Auth Service is authorized (on behalf of driver ID).

Authorizations:

bearerAuth

Request Body schema: application/json

id	string <uuid>
email	string
name	string
org_id	string
phone_number	string
vehicle_type	string
vehicle_plate_number	string

Responses

Request samples

Payload

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"email": "string",
"name": "string",
"org_id": "string",
"phone_number": "string",
"vehicle_type": "string",
"vehicle_plate_number": "string"
}

Response samples

201

Content type

application/json

{"code": "string",
"message": "string",
"driver_profile": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"full_name": "string",
"email": "string",
"partial_id_chars": "string",
"driver_verified_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z",
"vehicle_type": "string",
"vehicle_plate_number": "string",
"vehicle_plate_number_proof": {"name": "string",
"url": "string"
},
"vehicle_plate_number_verified_at": "2019-08-24T14:15:22Z",
"phone_number": "string",
"is_qa": true,
"group_tag": "string",
"org_id": "string",
"display_picture": {"name": "string",
"url": "string"
},
"is_available": true,
"latitude": 0,
"longitude": 0,
"version_seq": 0,
"version_rev": "0-xxxxxxxx",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"last_active_at": "2019-08-24T14:15:22Z",
"last_suspended_until": "2019-08-24T14:15:22Z"
}
}

Delete a driver profile

Only drivers are authorized.

Authorizations:

bearerAuth

Request Body schema: application/json

version_rev

required

string

Responses

Request samples

Payload

Content type

application/json

{"version_rev": "string"
}

Response samples

200
401
403
404

Content type

application/json

{"code": "success",
"driver_profile": {"id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"name": "John Doe",
"display_name": "John",
"email": "johndoe@example.com",
"partial_id_chars": "123C",
"driver_verified_at": "2020-12-30T04:21:29.712Z",
"vehicle_plate_number": "abc4321b",
"vehicle_plate_number_proof": {"name": "proof1",
"url": "https://www.abc.com/proof1.jpg"
},
"vehicle_plate_number_verified_at": "2020-12-30T04:21:29.712Z",
"phone_number": 12345678,
"is_qa": false,
"group_tag": "tag1",
"org_id": "FreelanceDriver",
"display_picture": {"name": "pic1",
"url": "https://www.abc.com/pic1.jpg"
},
"is_available": true,
"latitude": 1.43,
"longitude": 103.222,
"version_seq": 0,
"version_rev": "0-1a2b3c4d",
"created_at": "2020-12-30T04:21:29.712Z",
"updated_at": "2020-12-30T04:21:29.712Z",
"last_active_at": "2020-12-30T04:21:29.712Z",
"last_suspended_until": "2020-12-30T04:21:29.712Z"
},
"server_time": "2020-12-30T04:21:29.712Z"
}

Update personal details

Only drivers are authorized.

Authorizations:

bearerAuth

Request Body schema: application/json

name required	string
phone_number required	string
version_rev required	string

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"phone_number": "string",
"version_rev": "string"
}

Response samples

200
401
403
404

Content type

application/json

{"code": "success",
"driver_profile": {"id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"name": "John Doe",
"display_name": "John",
"email": "johndoe@example.com",
"partial_id_chars": "123C",
"driver_verified_at": "2020-12-30T04:21:29.712Z",
"vehicle_plate_number": "abc4321b",
"vehicle_plate_number_proof": {"name": "proof1",
"url": "https://www.abc.com/proof1.jpg"
},
"vehicle_plate_number_verified_at": "2020-12-30T04:21:29.712Z",
"phone_number": 12345678,
"is_qa": false,
"group_tag": "tag1",
"org_id": "FreelanceDriver",
"display_picture": {"name": "pic1",
"url": "https://www.abc.com/pic1.jpg"
},
"is_available": true,
"latitude": 1.43,
"longitude": 103.222,
"version_seq": 0,
"version_rev": "0-1a2b3c4d",
"created_at": "2020-12-30T04:21:29.712Z",
"updated_at": "2020-12-30T04:21:29.712Z",
"last_active_at": "2020-12-30T04:21:29.712Z",
"last_suspended_until": "2020-12-30T04:21:29.712Z"
},
"server_time": "2020-12-30T04:21:29.712Z"
}

Update vehicle details

Only drivers are authorized.

Authorizations:

bearerAuth

Request Body schema: application/json

vehicle_type required	string Enum: "ltl" "motorcycle" "car" "mpv" "van_1.7m" "van_2.4m" "lorry_10ft" "lorry_14ft" "lorry_24ft" "lorry_40ft" "boat"
vehicle_plate_number required	string
version_rev required	string

Responses

Request samples

Payload

Content type

application/json

{"vehicle_type": "ltl",
"vehicle_plate_number": "string",
"version_rev": "string"
}

Response samples

200
401
403
404

Content type

application/json

{"code": "success",
"driver_profile": {"id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"name": "John Doe",
"display_name": "John",
"email": "johndoe@example.com",
"partial_id_chars": "123C",
"driver_verified_at": "2020-12-30T04:21:29.712Z",
"vehicle_plate_number": "abc4321b",
"vehicle_plate_number_proof": {"name": "proof1",
"url": "https://www.abc.com/proof1.jpg"
},
"vehicle_plate_number_verified_at": "2020-12-30T04:21:29.712Z",
"phone_number": 12345678,
"is_qa": false,
"group_tag": "tag1",
"org_id": "FreelanceDriver",
"display_picture": {"name": "pic1",
"url": "https://www.abc.com/pic1.jpg"
},
"is_available": true,
"latitude": 1.43,
"longitude": 103.222,
"version_seq": 0,
"version_rev": "0-1a2b3c4d",
"created_at": "2020-12-30T04:21:29.712Z",
"updated_at": "2020-12-30T04:21:29.712Z",
"last_active_at": "2020-12-30T04:21:29.712Z",
"last_suspended_until": "2020-12-30T04:21:29.712Z"
},
"server_time": "2020-12-30T04:21:29.712Z"
}

Verify driver

Only VersaFleet's SysAdmin is authorized.

Authorizations:

bearerAuth

path Parameters

driver_id

required

string

ID of the driver who needs to be verified

Responses

Response samples

200
400

Content type

application/json

{"code": "string",
"message": "string"
}

Verify vehicle plate number proof

Only VersaFleet's SysAdmin is authorized.

Authorizations:

bearerAuth

path Parameters

driver_id

required

string

ID of the driver whose vehicle plate number needs to be verified

Responses

Response samples

200
400

Content type

application/json

{"code": "string",
"message": "string"
}

Update driver location

Only drivers is authorized.

Authorizations:

bearerAuth

Request Body schema: application/json

latitude required	number
longitude required	number

Responses

Request samples

Payload

Content type

application/json

{"latitude": 1.43,
"longitude": 103.222
}

Response samples

200
401
403
404

Content type

application/json

{"code": "success",
"driver_profile": {"id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"name": "John Doe",
"display_name": "John",
"email": "johndoe@example.com",
"partial_id_chars": "123C",
"driver_verified_at": "2020-12-30T04:21:29.712Z",
"vehicle_plate_number": "abc4321b",
"vehicle_plate_number_proof": {"name": "proof1",
"url": "https://www.abc.com/proof1.jpg"
},
"vehicle_plate_number_verified_at": "2020-12-30T04:21:29.712Z",
"phone_number": 12345678,
"is_qa": false,
"group_tag": "tag1",
"org_id": "FreelanceDriver",
"display_picture": {"name": "pic1",
"url": "https://www.abc.com/pic1.jpg"
},
"is_available": true,
"latitude": 1.43,
"longitude": 103.222,
"version_seq": 0,
"version_rev": "0-1a2b3c4d",
"created_at": "2020-12-30T04:21:29.712Z",
"updated_at": "2020-12-30T04:21:29.712Z",
"last_active_at": "2020-12-30T04:21:29.712Z",
"last_suspended_until": "2020-12-30T04:21:29.712Z"
},
"server_time": "2020-12-30T04:21:29.712Z"
}

Get selected drivers by OrgAdmin

Only OrgAdmin is authorized. Only HTTP/2.0 is allowed

Authorizations:

bearerAuth

Request Body schema: application/json

driver_ids

required

Array of strings <uuid>

Responses

Request samples

Payload

Content type

application/json

{"driver_ids": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}

Response samples

200
401
403

Content type

application/json

Example

No profiles exist

{"code": "success",
"drivers": [ ],
"server_time": "2021-09-23T15:47:26.699327+08:00"
}

Get selected drivers by SysAdmin

Only SysAdmin is authorized. Only HTTP/2.0 is allowed

Authorizations:

bearerAuth

Request Body schema: application/json

driver_ids

required

Array of strings <uuid>

Responses

Request samples

Payload

Content type

application/json

{"driver_ids": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}

Response samples

200
401
403

Content type

application/json

Example

No profiles exist

{"code": "success",
"drivers": [ ],
"server_time": "2021-09-23T15:47:26.699327+08:00"
}

Get drivers summary

Only SysAdmin is authorized.

Authorizations:

bearerAuth

Request Body schema: application/json

driver_ids

required

Array of strings <uuid>

Responses

Request samples

Payload

Content type

application/json

{"driver_ids": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}

Response samples

200
401
403

Content type

application/json

{"code": "success",
"drivers": [{"id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"last_active": "2021-09-23T15:47:26.699327+08:00",
"joined_since": "2021-01-02T11:00:00Z",
"last_location": {"latitude": 1.43,
"longitude": 103.222
}
}
],
"server_time": "2021-09-23T15:47:26.699327+08:00"
}

Get paginated driver profile list with squad details

Only SysAdmin is authorized.

Authorizations:

bearerAuth

query Parameters

page	integer <int64> >= 1 Default: 1
per_page	integer <int64> >= 1 Default: 200

Responses

Response samples

200
401
403

Content type

application/json

Example

No profiles exist

{"meta": {"page": 1,
"per_page": 200
},
"driver_profiles": [ ]
}

Get mobile app minimum version

Authorizations:

bearerAuth

Responses

Response samples

200

Content type

application/json

{"minimum_version": "2.19.0"
}

Get transport app minimum version

Authorizations:

bearerAuth

Responses

Response samples

200
401
403
404

Content type

application/json

{"minimum_version": "0.23.1"
}

Get driver profile detail by ID

Authorizations:

bearerAuth

query Parameters

driver_id

Array of strings

Id of the drivers

Responses

Response samples

200
401
404

Content type

application/json

{"id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"name": "John Doe",
"email": "johndoe@example.com",
"partial_id_chars": "123C",
"driver_verified_at": "2020-12-30T04:21:29.712Z",
"vehicle_plate_number": "abc4321b",
"version_seq": 0,
"version_rev": "0-1a2b3c4d"
}

Sync Org Driver

Sync organization driver with driver profile

Authorizations:

bearerAuth

query Parameters

driver_id

Array of strings

Id of the drivers

Request Body schema: application/json

name required	string
phone_number	string
vehicle_plate_number	string

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"phone_number": "string",
"vehicle_plate_number": "string"
}

Response samples

200
401
404

Content type

application/json

{"message": "Successfully updated driver profile"
}