Driver object

First available in SystemsLink: 2014.2

Used by External SystemsLink for TMWSuite.

Methods

The Return Value for all methods is Driver.ReturnObject.
Method Name Parameters Driver.ReturnObject.ReturnCode Description

Name

Data type (in C#)

NewDriver

N/A

0 = successful

1000 = errors occurred

Creates a new Driver object in memory

NewDrivers

total

int

0 = successful

1000 = errors occurred

Creates the specified number of new Driver objects in memory

RetrieveDriver

criteria

Driver.Criteria

0 = successful

100 = no records found

1000 = errors occurred

Returns all Driver objects that meet the provided criteria

SaveDriver

drivers

List<Driver>

0 = successful

100 = validation errors occurred and updates prevented

500 = update proceeded with warnings

1000 = error occurred and updates prevented

Saves the provided Driver objects and updates the database if requested, then returns the saved objects if the save was successful

updateDB

bool

Properties and column mapping

To condense the information in this table, the Database Column Name uses the following abbreviations for database tables:

m = manpowerprofile

Property Database Column Modifiable Comments

Name

Data Type (in C#)

Name

Data Type

1

AccountingType

string

m.mpp_actg_type

char(1)

Insert/Update

2

Address1

string

m.mpp_address1

varchar(30)

Insert/Update

3

Address2

string

m.mpp_address2

varchar(30)

Insert/Update

4

AltID

string

m.mpp_otherid

varchar(25)

Insert/Update

5

BirthDate

DateTime

m.mpp_dateofbirth

datetime

Insert/Update

6

City

int

m.mpp_city

int

Insert/Update

7

Company

string

m.mpp_company

varchar(6)

Insert/Update

8

Country

string

m.mpp_country

varchar(6)

Insert/Update

9

Currency

string

m.mpp_currency

varchar(6)

Insert/Update

10

CurrentPhone

string

m.mpp_currentphone

varchar(20)

Insert/Update

11

DataSourceID

string

N/A

Not mapped

12

Division

string

m.mpp_division

varchar(6)

Insert/Update

13

Domicile

string

m.mpp_domicile

va)rchar(6

Insert/Update

14

DriverID

string

m.mpp_id

varchar(8)

Insert

Key

15

DRVMisc1

string

m.mpp_misc1

varchar(254)

Insert/Update

16

DRVMisc2

string

m.mpp_misc2

varchar(254)

Insert/Update

17

DRVMisc3

string

m.mpp_misc3

varchar(254)

Insert/Update

18

DRVMisc4

string

m.mpp_misc4

varchar(254)

Insert/Update

19

Email

string

m.mpp_email

varchar(50)

Insert/Update

20

EmergencyContact

string

m.mpp_emername

varchar(40)

Insert/Update

21

EmergencyPhone

string

m.mpp_emerphone

varchar(20)

Insert/Update

22

ExpirationAssetID

string

m.mpp_id

varchar(8)

Read only

Returns value of DriverID

23

ExpirationAssetType

AssetTypeEnum

Read only

Returns AssetTypeEnum.DRV

24

Expirations

List <Expiration>

Insert/Update

Reference Expiration Object in Expiration table

25

FirstName

string

m.mpp_firstname

varchar(40)

Insert/Update

26

Fleet

string

m.mpp_fleet

varchar(6)

Insert/Update

27

HireDate

DateTime

m.mpp_hiredate

datetime

Insert/Update

28

HomePhone

string

m.mpp_homephone

varchar(20)

Insert/Update

29

IsDirty

bool

N/A

Not mapped or used in service

30

IsNew

bool

N/A

Not mapped, set to false during save to update

31

IsValid

bool

N/A

Not mapped or used in service

32

LastCommunicationDate

DateTime

m.mpp_lastmobilecomm

datetime

Insert/Update

33

LastHomeDate

DateTime

m.mpp_last_home

datetime

Insert/Update

34

LastName

string

m.mpp_lastname

varchar(40)

Insert/Update

35

LicenseClass

string

m.mpp_licenseclass

varchar(15)

Insert/Update

36

LicenseNumber

string

m.mpp_licensenumber

varchar(25)

Insert/Update

37

LicenseState

string

m.mpp_licensestate

varchar(6)

Insert/Update

38

MiddleName

string

m.mpp_middlename

char(1)

Insert/Update

39

mpp_90daystart

DateTime

m.mpp_90daystart

datetime

Insert/Update

40

mpp_avghourlypay

decimal

m.mpp_avghourlypay

Money

Insert/Update

41

mpp_avgperiodpay

decimal

m.mpp_avgperiodpay

money

Insert/Update

42

mpp_comparisonflag

string

m.mpp_comparisonflag

char(1)

Insert/Update

43

mpp_csa_score

int

m.mpp_csa_score

int

Insert/Update

44

mpp_dailyguarenteedhours

decimal

m.mpp_dailyguarenteedhours

money

Insert/Update

45

mpp_hourlyrate

decimal

m.mpp_hourlyrate

decimal(5,2)

Insert/Update

46

mpp_periodguarenteedhours

decimal

m.mpp_periodguarenteedhours

money

Insert/Update

47

MPPType1

string

m.mpp_type1

varchar(6)

Insert/Update

48

MPPType2

string

m.mpp_type2

varchar(6)

Insert/Update

49

MPPType3

string

m.mpp_type3

varchar(6)

Insert/Update

50

MPPType4

string

m.mpp_type4

varchar(6)

Insert/Update

51

OtherPhone

string

m.mpp_alternatephone

varchar(20)

Insert/Update

52

Payto

string

m.mpp_payto

varchar(12)

Insert/Update

53

PTADate

DateTime

m.mpp_pta_date

datetime

Insert/Update

54

Region1

string

m.mpp_prior_region1

varchar(6)

Insert/Update

55

Region2

string

m.mpp_prior_region2

varchar(6)

Insert/Update

56

Region3

string

m.mpp_prior_region3

varchar(6)

Insert/Update

57

Region4

string

m.mpp_prior_region4

varchar(6)

Insert/Update

58

SeniorityDate

DateTime

m.mpp_senioritydate

datetime

Insert/Update

59

ServiceRule

string

m.mpp_servicerule

varchar(6)

Insert/Update

60

State

string

m.mpp_state

varchar(6)

Insert/Update

61

Status

string

m.mpp_status

varchar(6)

Read only

62

TeamLeader

string

m.mpp_teamleader

varchar(6)

Insert/Update

63

Terminal

string

m.mpp_terminal

varchar(6)

Insert/Update

64

TerminateDate

DateTime

m.mpp_terminationdt

datetime

Insert/Update

65

TractorID

string

m.mpp_tractornumber

varchar(8)

Insert/Update

66

UpdateableProperties

DriverUpdateInfo

N/A

Not mapped

67

VoiceMailPhone

string

m.mpp_voicemailbox

varchar(20)

Insert/Update

68

WantHomeDate

DateTime

m.mpp_want_home

datetime

Insert/Update

69

Zip

string

m.mpp_zip

varchar(10)

Insert/Update

Driver.ReturnObject

Property Name Data Type (in C#) Comments

1

ErrorMessages

List <string>

2

ErrorObjectIndexList

List <int>

3

Exceptions

List <Exception>

4

ReferenceObjects

List <Driver>

5

ReturnCode

int

6

TraceMessages

List <string>

7

WarningMessages

List <string>

DriverUpdateInfo object

  • Data types (in C#) for all properties are bool.

  • Set the property to true to update the corresponding Driver property.

Property Name

1

AccountingType

2

Address1

3

Address2

4

AltID

5

BirthDate

6

City

7

Company

8

Country

9

Currency

10

CurrentPhone

11

Division

12

Domicile

13

DriverID

14

DRVMisc1

15

DRVMisc2

16

DRVMisc3

17

DRVMisc4

18

Email

19

EmergencyContact

20

EmergencyPhone

21

Expirations

22

FirstName

23

Fleet

24

HireDate

25

HomePhone

26

LastCommunicationDate

27

LastHomeDate

28

LastName

29

LicenseClass

30

LicenseNumber

31

LicenseState

32

MiddleName

33

mpp_90daystart

34

mpp_avghourlypay

35

mpp_avgperiodpay

36

mpp_comparisonflag

37

mpp_csa_score

38

mpp_dailyguarenteedhours

39

mpp_hourlyrate

40

mpp_periodguarenteedhours

41

MPPType1

42

MPPType2

43

MPPType3

44

MPPType4

45

OtherPhone

46

Payto

47

PTADate

48

Region1

49

Region2

50

Region3

51

Region4

52

SeniorityDate

53

ServiceRule

54

State

55

TeamLeader

56

Terminal

57

TerminateDate

58

TractorID

59

VoiceMailPhone

60

WantHomeDate

61

Zip

Criteria object

To condense the information in table, the Database Column uses the following abbreviations for database tables:

m = manpowerprofile

Name Database Column Data Type (in C#) Comments

1

AltID

m.mpp_otherid

string

2

City

m.mpp_city

int?

3

Company

m.mpp_company

string

4

Country

m.mpp_country

string

5

CurrentPhone

m.mpp_currentphone

string

6

Division

m.mpp_division

string

7

DriverID

m.mpp_id

string

8

DRVMisc1

m.mpp_misc1

string

9

DRVMisc2

m.mpp_misc2

string

10

DRVMisc3

m.mpp_misc3

string

11

DRVMisc4

m.mpp_misc4

string

12

Email

m.mpp_email

string

13

EmergencyPhone

m.mpp_emerphone

string

14

FirstName

m.mpp_firstname

string

15

Fleet

m.mpp_fleet

string

16

HomePhone

m.mpp_homephone

string

17

LastName

m.mpp_lastname

string

18

MPPType1

m.mpp_type1

string

19

MPPType2

m.mpp_type2

string

20

MPPType3

m.mpp_type3

string

21

MPPType4

m.mpp_type4

string

22

OtherPhone

m.mpp_alternatephone

string

23

Region1

m.mpp_prior_region1

string

24

Region2

m.mpp_prior_region2

string

25

Region3

m.mpp_prior_region3

string

26

Region4

m.mpp_prior_region4

string

27

State

m.mpp_state

string

28

Status

m.mpp_status

string

29

TeamLeader

m.mpp_teamleader

string

30

Terminal

m.mpp_terminal

string

31

TractorID

m.mpp_tractornumber

string

32

VoiceMailPhone

m.mpp_voicemailbox

string

33

Zip

m.mpp_zip

string