DriverService
First available in SystemsLink: 2017.3.0
The DriverService includes methods for working with driver profiles and activities, including messages, notifications, working hours, Ids, and other data.
The driver master file consists of profiles of all drivers used by your company. This includes company drivers, owner/operators who drive, and drivers who work for inside carriers. A profile must exist for a driver before you can dispatch him on a trip. Driver profiles are recorded in the Driver Profile window.
Endpoint Address: [SystemsLinkRootUrl]/DriverService.svc
Methods
Method Name | Parameters | C# return type | Description | |
---|---|---|---|---|
Name |
C# data type |
|||
CreateMessage |
driverId |
string |
void |
Create a new message with the specified driverId, subject and message. |
subject |
string |
|||
message |
string |
|||
Delete |
driverId |
string |
void |
Delete specified driverId. |
Get |
driverId |
string |
Driver |
Retrieve the driver with the specified driverId. |
GetByAltId |
driverAltId |
string |
Driver |
Retrieve the driver with the specified driverAltId. |
GetByEmail |
string |
Driver |
Retrieve the driver with the specified email. |
|
GetHoursOfService |
driverId |
string |
DriverHoursOfService |
Retrieve the hours worked by a driver as specified by driverId and date. |
date |
DateTime |
|||
GetMessages |
driverId |
string |
List<DriverMessage> |
Retrieve a list of DriverMessages for a driverId with the specified pageIndex and pageSize. |
pageIndex |
int |
|||
pageSize |
int |
|||
GetNotifications |
driverId |
string |
List<DriverNotification> |
Retrieve a list of GetNotifications for a driverId with the specified pageIndex and pageSize. |
pageIndex |
int |
|||
pageSize |
int |
|||
NewItem |
Driver |
Create a new driver. |
||
Save |
driver |
Driver |
Driver |
Save a driver. |
Search |
driverFilter |
FilterObjectOfDriver |
PagedResultOfDriver |
Search for a driver. |
Properties and column mapping
Columns in Database Column Name are from the manpowerprofile database table. |
Property | Database column | Comments | ||
---|---|---|---|---|
Name |
C# data type |
Name |
Data type |
|
AltId |
string |
mpp_otherid |
varchar(25) |
|
Branch |
string |
mpp_branch |
varchar(12) |
|
ControlData |
string |
Not mapped to database. |
||
CreatedBy |
string |
Not mapped to database. |
||
CreatedDateTime |
DateTime? |
mpp_createdate |
datetime |
|
Division |
string |
mpp_division |
varchar(6) |
|
Domicile |
string |
mpp_domicile |
varchar(6) |
|
DriverId |
string |
mpp_id |
varchar(8) |
|
DriverType1 |
string |
mpp_type1 |
varchar(6) |
|
DriverType2 |
string |
mpp_type2 |
varchar(6) |
|
DriverType3 |
string |
mpp_type3 |
varchar(6) |
|
DriverType4 |
string |
mpp_type4 |
varchar(6) |
|
string |
mpp_email |
varchar(50) |
||
FirstName |
string |
mpp_firstname |
varchar(40) |
|
Fleet |
string |
mpp_fleet |
varchar(6) |
|
HomeTerminal |
string |
mpp_athome_terminal |
varchar(8) |
|
LastName |
string |
mpp_lastname |
varchar(40) |
|
MiddleName |
string |
mpp_middlename |
char(1) |
|
Misc1 |
string |
mpp_misc1 |
varchar(254) |
|
Misc2 |
string |
mpp_misc2 |
varchar(254) |
|
Misc3 |
string |
mpp_misc3 |
varchar(254) |
|
Misc4 |
string |
mpp_misc4 |
varchar(254) |
|
RuleData |
List <ConcurrencyFieldRule> |
Not mapped to database. |
||
Status |
string |
mpp_status |
varchar(6) |
|
SubCompany |
string |
mpp_company |
varchar(8) |
|
TeamLeader |
string |
mpp_teamleader |
varchar(6) |
|
Terminal |
string |
mpp_terminal |
varchar(8) |
|
TerminationDate |
DateTime? |
mpp_terminationdt |
datetime |
|
TractorId |
string |
mpp_tractornumber |
varchar(8) |
|
UpdateDateTime |
DateTime? |
mpp_updateon |
datetime |
|
UpdatedBy |
string |
mpp_updatedby |
varchar(256) |