add a driver - RoscoLive API v1.0

Request

Body Params multipart/form-data

company_id

integer

required

ID of company

>= 0

Example:

12345

first_name

string

required

Driver first name

Example:

{% faker name.firstName %}

last_name

string

required

Driver last name

Example:

{% faker name.lastName %}

email

string

required

Email address of the driver

Example:

{% faker internet.exampleEmail %}

card_id

string

required

Driver ID card

>= 8 characters<= 8 characters

Example:

A1B2C3D4

Match pattern:

^[A-Fa-f0-9]+

group_id

integer

optional

ID of group driver will be assigned to

>= 0

Example:

12345

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request PUT 'https://fleet.roscolive.com/api/v1.0/driver' \
--form 'company_id="12345"' \
--form 'first_name="{% faker name.firstName %}"' \
--form 'last_name="{% faker name.lastName %}"' \
--form 'email="{% faker internet.exampleEmail %}"' \
--form 'card_id="A1B2C3D4"' \
--form 'group_id="12345"'

Responses

🟢200Success

application/json

Body

meta

object

required

Request metadata object

code

integer

required

HTTP status code returned by server

response

object

required

Contains response data

card_id

string

required

Assigned card ID

>= 8 characters<= 8 characters

Match pattern:

^[A-Fa-f0-9]+

card_scan_ts

required

Timestamp of latest card scan with ID

company_id

integer

required

ID of company

creation_ts

string <date-time>

required

Timestamp of driver user creation

Example:

2024-01-01 12:31:42

device_id

required

Device ID of last device scanned into

email

string

required

Email address of the driver

first_name

string

required

First name of driver

group_id

required

ID of assigned group in company

group_name

required

Name of assigned group in company

id

integer

required

ID of driver record

last_name

string

required

Last name of driver

name

string

required

Full name of driver

parent_driver_id

null

deprecated

Unused, will be depreciated in a future version

photos

array[string]

required

Unused, will always return empty. Will be depreciated in a future version.

status

string

required

User database status

type

enum<string>

required

Type of driver ID method used by company

Allowed values:

manualcard_id

result

string

required

"OK" if request successful, otherwise "Failed"

Example

{
  "meta": {
    "code": 200
  },
  "response": {
    "card_id": "a2b3c4d5",
    "card_scan_ts": null,
    "company_id": 2,
    "creation_ts": "2024-08-09 18:17:37",
    "device_id": null,
    "email": "Jeanette.Christiansen@example.org",
    "first_name": "Makayla",
    "group_id": null,
    "group_name": null,
    "id": 2842,
    "last_name": "Goldner",
    "name": "Makayla Goldner",
    "parent_driver_id": null,
    "photos": [],
    "status": "used",
    "type": "manual"
  },
  "result": "OK"
}

🟠401Login Required

🟠404Record Not Found