1. Drivers
  • Introduction
  • Getting Started
  • Authentication
  • Error Handling
  • Contact Support
  • Modaltrans API
    • Get Auth Token
      • Get Bearer Token
    • Accounting
      • Invoices
        • Retrieve an Invoice
        • List all Invoices
    • Customs
      • NCTS Declarations
        • List all NCTS Declarations
        • Retrieve an NCTS Declaration
        • Create an NCTS Declaration with XML Data
        • Create an Ens Declaration from JSON
        • Update an NCTS Declaration
        • Download an NCTS Declaration
        • List Timelines of NCTS Declaration
        • List Messages of NCTS Decalaration
      • Customs Declarations
        • List all Customs Declarations
        • Retrieve a Custom Declaration
        • Create a Customs Declaration
        • Update a Custom Declaration
        • Delete a Custom Declaration
        • Retrieve a Declaration History
        • Retrieve an MRN Status of Declaration
      • Declaration Requests
        • List all Declaration Orders
        • Retrieve a Declaration Request
        • Create a Declaration Request
        • Update a Declaration Request
        • Delete a Declaration Request
    • Logistics
      • Bookings
        • Retrieve a Booking
        • List all Bookings
        • Create a Booking
        • Update a Booking
      • Locations
        • List all Locations
        • Retrieve a Location
      • Positions
        • Update a Transport
      • Tracking
        • Available Shipping Lines
        • Retrieve a Tracking Data
        • Subscribe to Tracking
      • Shipments
        • Retrieve a Shipment
        • List All Shipments
        • Retrieve Financials of Shipment
        • List Contacts of the Shipment
        • Create a Shipment
        • Update a Shipment
    • Depot
      • Orders
        • Retrieve an Order
        • List all Orders
        • Create an Order
        • Update an Order
      • Products
        • Retrieve a Product
        • List all Products
        • Create a Product
        • Update a Product
        • List Product Stocks
      • Inventories
        • List all Inventories
    • Fleet Management
      • Drivers
        • Retrieve a Driver
          GET
        • Retrieve a Driver's Vehicle
          GET
        • List Driver Positions
          GET
        • Update a Driver
          PATCH
      • Vehicles
        • Retrieve a Vehicle
        • Update a Vehicle
      • Gps Service Controller
        • Create Gps Responses
      • Service Logs
        • List all Service Logs
        • Retrieve a Service Log
        • Create a Service Log
        • Delete a Service Log
        • Update a Service Log
      • Periodic Documents
        • Retrieve a Periodic Document
        • Update a Periodic Document
        • Create a Periodic Document
    • CRM
      • Companies
        • List all Companies
        • Retrieve a Company
        • Create a Company
        • Update a Company
        • Delete a Company
    • Timelines
      • Retrieve a Timeline
      • List Timelines
      • Create a Timeline
    • S3 Files
      • List all S3Files
      • Create an S3File
      • Delete an S3File
    • Notifications
      • List all Notifications
      • Update a Notification Status
    • User Details
      • List User Details
      • Update User Details
  1. Drivers

Retrieve a Driver

Developing
Testing Env
https://demo.modaltrans.com
Testing Env
https://demo.modaltrans.com
GET
/api/v1/drivers/{uuid}
Retrieves a drivers information by its UUID.

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
Path Params
uuid
string 
required
UUID of the driver.

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://demo.modaltrans.com/api/v1/drivers/'

Responses

🟢200OK
application/json
Body
uuid
string <uuid>
required
UUID of the driver
name
string 
required
Name of the driver
gsm
string 
required
GSM number of the driver
status
string 
required
Current status of the driver
work_type
string 
required
Type of work the driver is assigned to
avatar
object 
required
Image of the driver
avatar
object  | null 
required
trailer_id
integer 
required
ID of the trailer assigned to the driver
balances
string 
required
Balances related to the driver
timeoff
string 
required
Time off details for the driver
vehicle_id
integer 
required
ID of the vehicle assigned to the driver
vehicle_code
string 
required
Code/Plate Number of the vehicle assigned to the driver
truck
object 
required
Details of the truck assigned to the driver
code
string 
required
Code/Plate Number of the truck
name
string 
required
Name of the truck
model_year
integer 
required
Model year of the truck
uuid
string <uuid>
required
UUID of the truck
trailer
object 
required
Details of the trailer assigned to the driver
code
string 
required
Code/Plate Number of the trailer
name
string 
required
Name of the trailer
model_year
integer 
required
Model year of the trailer
uuid
string <uuid>
required
UUID of the trailer
assigned_truck
string 
required
Truck assigned to the driver
assigned_trailer
string 
required
Trailer assigned to the driver
periodocs
array [object {8}] 
required
Periodical documents related to the driver
uuid
string <uuid>
required
UUID of the periodical document
periodoc_type_id
integer 
required
Type of the periodical document
doc_no
string 
required
Document number
doc_date
string <time>
required
Date of the document
start_date
string <time>
required
Start date of the document
due_date
string <time>
required
Due date of the document
status
string 
required
Current status of the document
periodoc_type_name
string 
required
Name of the periodical document type
Example
{
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
    "name": "string",
    "gsm": "string",
    "status": "string",
    "work_type": "string",
    "avatar": {
        "avatar": {
            "url": "string"
        }
    },
    "trailer_id": 0,
    "balances": "string",
    "timeoff": "string",
    "vehicle_id": 0,
    "vehicle_code": "string",
    "truck": {
        "code": "string",
        "name": "string",
        "model_year": 0,
        "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
    },
    "trailer": {
        "code": "string",
        "name": "string",
        "model_year": 0,
        "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
    },
    "assigned_truck": "string",
    "assigned_trailer": "string",
    "periodocs": [
        {
            "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
            "periodoc_type_id": 0,
            "doc_no": "string",
            "doc_date": "14:15:22Z",
            "start_date": "14:15:22Z",
            "due_date": "14:15:22Z",
            "status": "string",
            "periodoc_type_name": "string"
        }
    ]
}
🟠400Bad Request
🟠403Forbidden
🟠404Record Not Found
Modified at 2024-08-23 13:37:44
Previous
List all Inventories
Next
Retrieve a Driver's Vehicle
Built with