Carrier object

First available in SystemsLink: 2014.2

Used by External SystemsLink for TMWSuite.

Methods

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

Name

Data type (in C#)

NewCarrier

N/A

0 = successful

1000 = errors occurred

Creates a new Carrier object in memory

NewCarriers

total

int

0 = successful

1000 = errors occurred

Creates the specified number of new Carrier objects in memory

RetrieveCarrier

criteria

Carrier.Criteria

0 = successful

100 = no records found

1000 = errors occurred

Returns all Carrier objects that meet the provided criteria

SaveCarrier

carriers

List<Carrier>

0 = successful

100 = validation errors occurred and updates prevented

500 = update proceeded with warnings

1000 = error occurred and updates prevented

Saves the provided Carrier 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:

c = carrier

Property Database Column Modifiable Comments

Name

Data Type (in C#)

Name

Data Type

1

AccountingEntity

string

c.car_actg_type

varchar(6)

Insert/Update

2

Address1

string

c.car_address1

varchar(64)

Insert/Update

3

Address2

string

c.car_address2

varchar(64)

Insert/Update

4

Agent

string

c.car_agent

varchar(8)

Insert/Update

5

AltID

string

c.car_otherid

varchar(8)

Insert/Update

6

ApprovalDate

DateTime

c.car_approval_dt

datetime

Insert/Update

7

Board

bool

c.car_board

char(1)

Insert/Update

8

Branch

string

c.car_branch

varchar(12)

Insert/Update

9

CarMisc1

string

c.car_misc1

varchar(450)

Insert/Update

10

CarMisc2

string

c.car_misc2

varchar(450)

Insert/Update

11

CarMisc3

string

c.car_misc3

varchar(450)

Insert/Update

12

CarMisc4

string

c.car_misc4

varchar(450)

Insert/Update

13

CarrierHasInsuranceCertificateParameter

string

c.car_ins_certificate

char(1)

Insert/Update

First available in SystemsLink: 2014.4.0

14

CarrierHasInsuranceContractParameter

string

c.car_ins_contract

char(1)

Insert/Update

First available in SystemsLink: 2014.4.0

15

CarrierHasInsuranceW9Parameter

string

car_ins_w9

char(1)

Insert/Update

First available in SystemsLink: 2014.4.0

16

CarrierID

string

c.car_id

varchar(8)

Insert

Key

17

CarrierInsuranceLimitParameter

int

c.car_ins_cargolimits

int

Insert/Update

First available in SystemsLink: 2014.4.0

18

CarrierManager

string

c.car_manager

varchar(6)

Insert/Update

19

CarrierName

string

c.car_name

varchar(64)

Insert/Update

20

CarrierPhone

string

c.car_phone1

char(10)

Insert/Update

21

CarTrailerType1

string

c.car_trltype1

varchar(8)

Insert/Update

22

CarTrailerType2

string

c.car_trltype2

varchar(8)

Insert/Update

23

CarTrailerType3

string

c.car_trltype3

varchar(8)

Insert/Update

24

CarTrailerType4

string

c.car_trltype4

varchar(8)

Insert/Update

25

CarType1

string

c.car_type1

char(6)

Insert/Update

26

CarType2

string

c.car_type2

char(6)

Insert/Update

27

CarType3

string

c.car_type3

char(6)

Insert/Update

28

CarType4

string

c.car_type4

char(6)

Insert/Update

29

City

Int32

c.cty_code

int

Insert/Update

30

ConfirmationEmail

bool

c.car_confirmemail

tinyint

Insert/Update

31

ConfirmationFax

bool

c.car_confirmfax

tinyint

Insert/Update

32

ConfirmationFile

string

c.car_confirmpathname

char(256)

Insert/Update

33

ConfirmationKit

Int32

c.car_confirm_irk_id

int

Insert/Update

34

ConfirmationPrint

bool

c.car_confirmprint

tinyint

Insert/Update

35

ConfirmationReport

Int32

c.car_confirm_ir_id

int

Insert/Update

36

ConfirmationType

string

c.car_confirm_type

varchar(6)

Insert/Update

37

Contact

string

c.car_contact

varchar(20)

Insert/Update

38

County

string

c.car_country

varchar(6)

Insert/Update

39

Currency

string

c.car_currency

varchar(6)

Insert/Update

40

DataSourceID

string

N/A

Not mapped

41

DOTNumber

string

c.car_dotnum

varchar(20)

Insert/Update

42

EDI204

Int32

c.car_204flag

int

Insert/Update

43

EDI210

Int32

c.car_210flag

int

Insert/Update

44

EDI214

Int32

c.car_214flag

int

Insert/Update

45

EDIValidate

bool

c.car_204validate

int

Insert/Update

46

EFT

bool

c.car_eft_flag

smallint

Insert/Update

47

EmailAddress

string

c.car_email

varchar(128)

Insert/Update

48

ExpirationAssetID

string

c.car_id

varchar(8)

Read only

Returns CarrierID

49

ExpirationAssetType

AssetTypeEnum

Read only

Returns AssetTypeEnum.CAR

50

Expirations

List<Expiration>

Insert/Update

Reference Expiration Object in expirations table

51

ExternalEquipmentInterval

Int32

c.car_extequip_interval_hours

int

Insert/Update

52

ExternalEquipmentMaxCount

Int32

c.car_extequip_interval_maxcount

int

Insert/Update

53

ExternalEquipmentWarning

string

c.car_extequip_interal_warnlevel

char(6)

Insert/Update

54

Fax

string

c.car_phone3

char(10)

Insert/Update

55

FederalID

string

c.car_fedid

varchar(10)

Insert/Update

56

GPClass

string

c.car_gp_class

char(11)

Insert/Update

57

HazMat

bool

c.car_hazmat

smallint

Insert/Update

58

IsDirty

bool

N/A

Not mapped or used in service

59

IsNew

bool

N/A

Not mapped, set to false during save to update

60

IsValid

bool

N/A

Not mapped or used in service

61

LastActivity

DateTime

c.car_lastactivity

datetime

Insert/Update

62

LiabilityLimits

int

c.car_ins_liabilitylimits

int

Insert/Update

First available in SystemsLink: 2014.4.0

63

MCNumber

string

c.car_iccnum

varchar(12)

Insert/Update

64

PayTo

string

c.pto_id

varchar(12)

Insert/Update

65

RegionType

string

c.car_region_type

varchar(6)

Insert/Update

66

SCACCode

string

c.car_scac

char(4)

Insert/Update

67

SecondaryPhone

string

c.car_phone2

char(10)

Insert/Update

68

ServiceRating

string

c.car_rating

varchar(12)

Insert/Update

69

Status

string

c.car_status

varchar(6)

Read only

70

TenderBy

string

c.car_tenderloadby

char(1)

Insert/Update

71

Terms

string

c.car_fgt_pay_terms

varchar(6)

Insert/Update

72

TierRating

string

c.car_tier_rating

varchar(6)

Insert/Update

73

UpdateableProperties

CarrierUpdateInfo

N/A

Not mapped

74

UseCashCard

bool

c.car_usecashcard

char(1)

Insert/Update

75

WebAddress

string

c.car_web_address

varchar(128)

Insert/Update

76

Zip

string

c.car_zip

varchar(10)

Insert/Update

Carrier.ReturnObject

Property Name Data Type (in C#) Comments

1

ErrorMessages

List<string>

2

ErrorObjectIndexList

List<int>

3

Exceptions

List<Exception>

4

ReferenceObjects

List<Carrier>

5

ReturnCode

int

6

TraceMessages

List<string>

7

WarningMessages

List<string>

CarrierUpdateInfo object

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

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

Property Name Comments

1

AccountingEntity

2

Address1

3

Address2

4

Agent

5

AltID

6

ApprovalDate

7

Board

8

Branch

9

CarMisc1

10

CarMisc2

11

CarMisc3

12

CarMisc4

13

CarrierHasInsuranceCertificateParameter

First available in SystemsLink: 2014.4.0

14

CarrierHasInsuranceContractParameter

First available in SystemsLink: 2014.4.0

15

CarrierHasInsuranceW9Parameter

First available in SystemsLink: 2014.4.0

16

CarrierID

17

CarrierInsuranceLimitParameter

First available in SystemsLink: 2014.4.0

18

CarrierManager

19

CarrierName

20

CarrierPhone

21

CarTrailerType1

22

CarTrailerType2

23

CarTrailerType3

24

CarTrailerType4

25

CarType1

26

CarType2

27

CarType3

28

CarType4

29

City

30

ConfirmationEmail

31

ConfirmationFax

32

ConfirmationFile

33

ConfirmationKit

34

ConfirmationPrint

35

ConfirmationReport

36

ConfirmationType

37

Contact

38

County

39

Currency

40

DOTNumber

41

EDI204

42

EDI210

43

EDI214

44

EDIValidate

45

EFT

46

EmailAddress

47

Expirations

48

ExternalEquipmentInterval

49

ExternalEquipmentMaxCount

50

ExternalEquipmentWarning

51

Fax

52

FederalID

53

GPClass

54

HazMat

55

LastActivity

56

LiabilityLimits

First available in SystemsLink: 2014.4.0

57

MCNumber

58

PayTo

59

RegionType

60

SCACCode

61

SecondaryPhone

62

ServiceRating

63

TenderBy

64

Terms

65

TierRating

66

UseCashCard

67

WebAddress

68

Zip

Criteria object

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

c = carrier

Name Database Column Data Type (in C#) Comments

1

Address1

c.car_address1

string

Join company table

2

AltID

c.car_otherid

string

3

CarrierID

c.car_id

string

4

CarrierName

c.car_name

string

5

CarrierPhone

c.car_phone1

string

6

CarType1

c.car_misc1

string

7

CarType2

c.car_misc2

string

8

CarType3

c.car_misc3

string

9

CarType4

c.car_misc4

string

10

City

c.cty_code

int?

11

Contact

c.car_contact

string

12

Fax

c.car_phone3

string

13

FederalID

c.car_fedid

string

14

MCNumber

c.car_iccnum

string

15

PayTo

c.pto_id

string

16

PayToAltID

c.pto_id

string

17

SCACCode

c.car_scac

string

18

SecondaryPhone

c.car_phone2

string

19

Status

c.car_status

string

20

Zip

c.car_zip

string