driverAssignment Webhook

June 10, 2021 14:18

The following table describes the parameters for the driverAssignment event:

Parameter	Description
tenantName	The unique name of the Fleet
driver	Includes the following information about the driver: firstName: First name of the driver lastName: Last name of the driver driverID: Unique driver identifier
startTime	Time when the driver started driving the vehicle
endTime	Time when the driver stopped driving the vehicle
source	Source from which information is obtained to recognize the driver and assign Drive Time to driver. Possible values are: VLS: Visual Login System (VLS) recognizes the driver by scanning the face of the person driving, when inward camera is enabled, and then verifying this information against a database in Driver•i Cloud in order to identify the driver. BEACON: The system recognizes the driver based on one of the following: Physical beacon carried by the driver while driving Driver•i App beacon BEACON-PRIORITY: Device sends correction for previous driver assignment data and this takes priority over the information sent by physical beacon or Driver•i App beacon. DEFAULT: Vehicle is associated to a specific driver, and all drive time from the vehicle is assigned to the specified driver. USER: Managers assign unknown drive time to a driver on the IDMS Dashboard.
webhookType	The event corresponding to the webhook, in this case “driverAssignment”
vehicle	Includes the following information about the vehicle: licensePlateNumber: License plate number of the vehicle vehicleNumber: Unique vehicle number in the Fleet vin: Vehicle Identification Number
netradyneDriverVehicleAssociationId	Unique identifier assigned by Netradyne for a particular Drive Time

The following are the Webhook sample payloads for the driverAssignment event.

Scenario 1: Driver Recognized by the System

{ 

  "tenantName": "N969870011344933", 

  "driver": { 

    "firstName": "Kenneth", 

    "lastName": "Grimes", 

    "driverId": "kennethg" 

  }, 

  "startTime": 1601534660839, 

  "endTime": 1601534720766, 

  "source": "VLS", 

  "webhookType": "driverAssignment", 

  "vehicle": { 

    "licensePlateNumber": "TN445078", 

    "vehicleNumber": "TN445078", 

    "vin": "VIN_TN445078" 

  }, 

  "netradyneDriverVehicleAssociationId": "6bc09cff-aee6-4956-a8c6-d5f785ad92a3" 

}

Scenario 2: Drive Time Assigned to Driver by User in IDMS Dashboard

{ 

  "tenantName": "N969870011344933", 

  "driver": { 

    "firstName": "Kenneth", 

    "driverId": "wueiwq353" 

  }, 

  "startTime": 1601172000000, 

  "endTime": 1601173800000, 

  "source": "USER", 

  "userName": "testUser", 

  "webhookType": "driverAssignment", 

  "vehicle": { 

    "licensePlateNumber": "bagh-001", 

    "vehicleNumber": "bagh-001", 

    "vin": "" 

  }, 

  "netradyneDriverVehicleAssociationId": "6bc09cff-aee6-4956-a8c6-d5f785ad92a3" 

}

Scenario 3: Unknown Driver

{ 

  "tenantName": "N969870011344933", 

  "driver": null, 

  "startTime": 1601386598801, 

  "endTime": 1601386658728, 

  "source": "BEACON", 

  "webhookType": "driverAssignment", 

  "vehicle": { 

    "licensePlateNumber": "TX903196", 

    "vehicleNumber": "TX903196", 

    "vin": "VIN_TX903196" 

  }, 

  "netradyneDriverVehicleAssociationId": "6bc09cff-aee6-4956-a8c6-d5f785ad92a3" 

}

Scenario 4: Open Interval

{   

"tenantName": "N969870011344933",   

"driver": 

{     

"firstName": "Kenneth",    
 
"lastName": "Grimes",     

"driverId": "kennethg"   

},   

"startTime": 1601534660839,   

"endTime": 0,   

"source": "ELD",   

"webhookType": "driverAssignment",  
 
"vehicle": 

{     

"licensePlateNumber": "TN445078",    
 
"vehicleNumber": "TN445078",  
   
"vin": "VIN_TN445078"   

},   

"netradyneDriverVehicleAssociationId": "6bc09cff-aee6-4956-a8c6-d5f785ad92a3" }