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

List Driver Positions

Developing
Testing Env
https://demo.modaltrans.com
Testing Env
https://demo.modaltrans.com
GET
/api/v1/drivers/{uuid}/positions
Returns a list of driver positions

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.
Query Params
page
number 
optional
Page number of list. (The result is limited to 10 positons per page.)

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//positions?page='

Responses

🟢200OK
application/json
Body
array of:
uuid
string <uuid>
required
UUID of the Position
reference
string 
required
Reference number of the position
branch_id
integer 
required
ID of the branch
user_id
integer 
required
ID of the User
status
string 
required
Status of the position
contract_type
string 
required
Contract type of vehicle
extref
string 
required
Booking Reference
truck
string 
required
Code/Plate Number of truck
truck_type
string 
required
Type of the truck
trailer
string 
required
Code/Plate number of the plate
trailer_type
string 
required
Type of the trailer
truck_uuid
string <uuid>
required
UUID of the truck
trailer_uuid
string <uuid>
required
UUID of the trailer
driver_name
string 
required
Name of the driver
driver_gsm
string 
required
Gsm number of the driver
departure_date
string <date-time>
required
Departure Date
arrival_date
string <date-time>
required
Arrival Date
route
string 
required
Route
notes
string 
required
Additional Notes
supplier_id
integer 
required
ID of the supplier
supplier_name
string 
required
Name of the supplier
operator_name
string 
required
Name of the Operator
dep_place
string  | null 
optional
Departure Place
dep_city
object 
required
Departure City
id
integer 
required
code
string  | null 
optional
name
string 
required
tel_code
string  | null 
optional
country_id
string 
required
created_at
string <date-time>
required
updated_at
string <date-time>
required
states_code
string  | null 
optional
dep_country_id
string 
required
Departure Country ID
arv_place
string  | null 
optional
Arrival Place
arv_city
object 
required
Arrival City
id
integer 
required
code
string  | null 
optional
name
string 
required
tel_code
string  | null 
optional
country_id
string 
required
created_at
string <date-time>
required
updated_at
string <date-time>
required
states_code
string  | null 
optional
arv_country_id
string 
required
Arrival Country ID
transit_points
array[string]
required
Loading Points
untransit_points
array[string]
required
Unloading Points
border_date
string <date>
required
Border Crossing Date
waybill_type
string 
required
Type of the waybill
route_km
string 
required
Route Km
consigments
array [object {38}] 
required
Consigments
transaction_id
integer 
required
ID of the transaction
uuid
string <uuid>
required
UUID of the consigment
reference
string 
required
Reference number of consigment
branch_id
integer 
required
ID of the branch
company_id
integer 
required
ID of the company
company_name
string 
required
Name of the company
customer_ref
string 
optional
Reference of the customer
agent_ref
string 
optional
Reference of agent
consignee_name
string 
required
Name of the consignee
sender_name
string 
required
Name of the sender
load_place_id
integer  | null 
optional
ID of the loading place
load_city
string 
required
City of the loading place
load_zipcode
string 
optional
Zipcode of the loading place
load_coun
string 
required
Country of the loading place
load_place
string 
required
Loading place
unload_place_id
integer  | null 
optional
ID of the unloading place
unload_city
string 
required
City of the unloading place
unload_zipcode
string 
optional
Zipcode of the unloading place
unload_coun
string 
required
Country of the unloading place
unload_place
string 
required
Unloading place
brut_wg
number 
required
Total weight
volume
number 
required
Volume
ladameter
number 
required
Ladameter
status
string 
required
Status
commodity
string 
optional
Commodity
category
string  | null 
optional
Category
group_id
integer 
required
ID of the group
price_wg
number 
required
Volumetric Weight
teu
integer 
required
Twenty-Foot Equivalent Unit
saler_name
string 
required
Name of the seller
saler_email
string <email>
required
Email of the seller
saler_office_tel
string 
optional
Office Tel of seller
total_pack
number 
required
Total Pack
total_packs
string 
required
Name of the total packs
points
array[string]
optional
Points
timelines
array[string]
optional
Timelines
company_code
string  | null 
optional
Code of the company
tag_names
array[string]
optional
Tag names
Example
[
    {
        "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
        "reference": "string",
        "branch_id": 0,
        "user_id": 0,
        "status": "string",
        "contract_type": "string",
        "extref": "string",
        "truck": "string",
        "truck_type": "string",
        "trailer": "string",
        "trailer_type": "string",
        "truck_uuid": "46f1af84-24ed-4225-a13b-1bce4acb6844",
        "trailer_uuid": "84aa3b61-9461-47c5-90b0-d58f5ed5c1a6",
        "driver_name": "string",
        "driver_gsm": "string",
        "departure_date": "2019-08-24T14:15:22Z",
        "arrival_date": "2019-08-24T14:15:22Z",
        "route": "string",
        "notes": "string",
        "supplier_id": 0,
        "supplier_name": "string",
        "operator_name": "string",
        "dep_place": "string",
        "dep_city": {
            "id": 0,
            "code": "string",
            "name": "string",
            "tel_code": "string",
            "country_id": "string",
            "created_at": "2019-08-24T14:15:22Z",
            "updated_at": "2019-08-24T14:15:22Z",
            "states_code": "string"
        },
        "dep_country_id": "string",
        "arv_place": "string",
        "arv_city": {
            "id": 0,
            "code": "string",
            "name": "string",
            "tel_code": "string",
            "country_id": "string",
            "created_at": "2019-08-24T14:15:22Z",
            "updated_at": "2019-08-24T14:15:22Z",
            "states_code": "string"
        },
        "arv_country_id": "string",
        "transit_points": [
            "string"
        ],
        "untransit_points": [
            "string"
        ],
        "border_date": "2019-08-24",
        "waybill_type": "string",
        "route_km": "string",
        "consigments": [
            {
                "transaction_id": 0,
                "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
                "reference": "string",
                "branch_id": 0,
                "company_id": 0,
                "company_name": "string",
                "customer_ref": "string",
                "agent_ref": "string",
                "consignee_name": "string",
                "sender_name": "string",
                "load_place_id": 0,
                "load_city": "string",
                "load_zipcode": "string",
                "load_coun": "string",
                "load_place": "string",
                "unload_place_id": 0,
                "unload_city": "string",
                "unload_zipcode": "string",
                "unload_coun": "string",
                "unload_place": "string",
                "brut_wg": 0,
                "volume": 0,
                "ladameter": 0,
                "status": "string",
                "commodity": "string",
                "category": "string",
                "group_id": 0,
                "price_wg": 0,
                "teu": 0,
                "saler_name": "string",
                "saler_email": "user@example.com",
                "saler_office_tel": "string",
                "total_pack": 0,
                "total_packs": "string",
                "points": [
                    "string"
                ],
                "timelines": [
                    "string"
                ],
                "company_code": "string",
                "tag_names": [
                    "string"
                ]
            }
        ]
    }
]
🟠400Bad Request
🟠403Forbidden
🟠404Record Not Found
Modified at 2024-08-26 07:48:48
Previous
Retrieve a Driver's Vehicle
Next
Update a Driver
Built with