POST - Driver

The Driver Profile Service endpoints allows users to create, update, and delete a driver within Visibility.
In order to get started you'll have to create a basic Driver Object. The following guides below will help you create (POST), update (PUT), pull back (GET), and Delete (DELETE) a Driver.

To get started, users will first need to create a driver using the driver POST.

Creating a Driver

The POST driver endpoint allows the creation of a driver for a specific organization for easier assignment and for displaying driver information on shipments.

Here is the POST Endpoint:

HTTP Verb: POST
URI: https://{domain}.organizations.services.10-4.com/v1/Drivers
Authentication: Bearer Token

Adding Driver Details

The POST driver endpoint allows for the creation of a single driver. The required parameters are LastName, FirstName and PhoneNumber. The optional fields are EmailAddress, Note, and ImageFile. The post requires multipart form data for the body of the request and does not accept raw JSON data. Please see Driver image section for imageFile requirements.

Parameters

Description

Notes

Required

LastName

Driver's Last Name

Max length 40
characters

Required

FirstName

Driver's First Name

Max length 40
characters

Required

PhoneNumber

Driver's phone number. Can be used as a search option.

International Phone Number

Required

EmailAddress

Driver's email address.

Max length 100 characters

Optional

Note

Used for adding any additional information about the driver that users would need to see.

Max length 500 characters

Optional

ImageFile

Driver's Profile Image.

JPEG. Image cannot be more than 2mb and must be at least 70x70 pixels.

Optional

The result set will return a full JSON Driver object. The DriverImage is the url end point for the driver image.

{
    "data": [
        {
            "driverGuid": "87a23ea7-04e2-49a5-9978-e9e3d226fe92",
            "lastName": "LastName",
            "firstName": "FirstName",
            "phoneNumber": "+11231231234",
            "emailAddress": "[email protected]",
            "note": "I am a driver note ",
            "organizationGuid": "57264f6a-ab58-4f17-8a2b-188db2a5f1c7",
            "driverImage": "https://tnfrdevdoc.blob.core.windows.net/development/70/708c2c8a-e79f-4120-a675-8833e1a385d3.JPG?sv=2013-08-15&sr=b&sig=H73Mlchd13IKCFlckAGvH%2FhKhNIg%2FBjCAa2cMWnFYN4%3D&se=2021-09-21T20%3A00%3A43Z&sp=r",
            "createdDate": "2021-09-21T15:30:31.489-04:00",
            "updatedDate": "2021-09-21T15:30:31.489-04:00"
        }
    ],
    "messages": [],
    "totalPossibleCount": 1
}