Carrier object

Carrier 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

Name

Data Type (in C#)

Name

Data Type

Modifiable

Comments

1

AccountingEntity

bool

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

CarrierID

string

c.car_id

varchar(8)

Insert/Update

Required for update

14

CarrierManager

string

c.car_manager

varchar(6)

Insert/Update

15

CarrierName

string

c.car_name

varchar(64)

Insert/Update

16

CarrierPhone

string

c.car_phone1

char(10))

Insert/Update

17

CarTrailerType1

string

c.car_trltype1

varchar(6)

Insert/Update

18

CarTrailerType2

string

c.car_trltype2

varchar(6)

Insert/Update

19

CarTrailerType3

string

c.car_trltype3

varchar(6)

Insert/Update

20

CarTrailerType4

string

c.car_trltype4

varchar(6)

Insert/Update

21

CarType1

string

c.car_type1

char(6)

Insert/Update

22

CarType2

string

c.car_type2

char(6)

Insert/Update

23

CarType3

string

c.car_type3

char(6)

Insert/Update

24

CarType4

string

c.car_type4

char(6)

Insert/Update

25

City

int

c.cty_code

int

Insert/Update

26

ConfirmationEmail

bool

c.car_confirmemail

tinyint

Insert/Update

27

ConfirmationFax

bool

c.car_confirmfax

tinyint

Insert/Update

28

ConfirmationFile

string

c.car_confirmpathname

char(256)

Insert/Update

29

ConfirmationKit

int

c.car_confirm_irk_id

int

Insert/Update

30

ConfirmationPrint

bool

c.car_confirmprint

tinyint

Insert/Update

31

ConfirmationReport

int

c.car_confirm_ir_id

int

Insert/Update

32

ConfirmationType

string

c.car_confirm_type

varchar(6)

Insert/Update

33

Contact

string

c.car_contact

varchar(25)

Insert/Update

34

County

string

c.car_country

varchar(6)

Insert/Update

This property refers to the Country

35

Currency

string

c.car_currency

varchar(6)

Insert/Update

36

DataSourceID

string

N/A

Not mapped or used in service

37

DOTNumber

string

c.car_dotnom

varchar(20)

Insert/Update

38

EDI204

int

c.car_204flag

int

Insert/Update

39

EDI210

int

c.car_210flag

int

Insert/Update

40

EDI214

int

c.car_214flag

int

Insert/Update

41

EDIValidate

bool

c.car_204validate

int

Insert/Update

42

EFT

bool

c.car_eft_flag

smallint

Insert/Update

43

EmailAddress

string

c.car_email

varchar(128)

Insert/Update

44

ExpirationAssetID

string

Read-only

Contains Carrier ID

45

ExpirationAssetType

AssetTypeEnum

Read-only

Contains AssetTypeEnum.CAR

46

Expirations

List Expiration>

Insert/Update

Not mapped

47

ExternalEquipmentInterval

int

c.car_extequip_interval_hours

int

Insert/Update

48

ExternalEquipmentMaxCount

int

c.car_extequip_interval_maxcount

int

Insert/Update

49

ExternalEquipmentWarning

string

c.car_extequip_interval_warnlevel

char(6)

Insert/Update

50

Fax

string

c.car_phone3

char(10)

Insert/Update

51

FederalID

string

c.car_fedid

varchar(10)

Insert/Update

52

GPClass

string

c.car_gp_class

char(11)

Insert/Update

53

HazMat

bool

c.car_hazmat

smallint

Insert/Update

54

IsDirty

bool

N/A

Not mapped or used in service

55

IsNew

bool

N/A

Not mapped, set to false during save to update

56

IsValid

bool

N/A

Not mapped

57

LastActivity

DateTime

c.car_lastactivity

datetime

Insert/Update

58

MCNumber

string

c.car_iccnum

varchar(12)

Insert/Update

59

PayTo

string

c.pto_id

varchar(12)

Insert/Update

60

RegionType

string

c.car_region_type

varchar(6)

Insert/Update

61

SCACCode

string

c.car_scac

char(4)

Insert/Update

62

SecondaryPhone

string

c.car_phone2

char(10)

Insert/Update

63

ServiceRating

string

c.car_rating

varchar(12)

Insert/Update

64

Status

string

c.car_status

varchar(6)

Insert/Update

65

TenderBy

string

c.car_tenderloadby

char(1)

Insert/Update

66

Terms

string

c.car_fgt_pay_terms

varchar(6)

Insert/Update

67

TierRating

string

c.car_tier_rating

varchar(6)

Insert/Update

68

UpdateableProperties

CarrierUpdateInfo

N/A

Not mapped

69

UseCashCard

string

c.car_usecashcard

char(1)

Insert/Update

70

WebAddress

string

c.car_web_address

varchar(128)

Insert/Update

71

Zip

string

c.car_zip

varchar(10)

Insert/Update

Carrier methods

The Return Value for all methods is Carrier.ReturnObject.

Internal

Parameters

Method Name

Name

Data type (in C#)

Carrier.ReturnObject.
ReturnCode

Description

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 specified 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

External

Parameters

Method Name

Name

Data type (in C#)

Carrier.ReturnObject.
ReturnCode

Description

NewCarrier

tokenValue

string

0 = successful

1000 = errors occurred

Creates a new Carrier object in memory

NewCarriers

tokenValue

string

0 = successful

1000 = errors occurred

Creates the specified number of new Carrier objects in memory

total

int

RetrieveCarrier

tokenValue

string

0 = successful

100 = no records found

1000 = errors occurred

Returns all Carrier objects that meet the specified criteria

criteria

Carrier.Criteria

SaveCarrier

tokenValue

string

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

carriers

List<Carrier>

updateDB

bool

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

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

CarrierID

14

CarrierManager

15

CarrierName

16

CarrierPhone

17

CarTrailerType1

18

CarTrailerType2

19

CarTrailerType3

20

CarTrailerType4

21

CarType1

22

CarType2

23

CarType3

24

CarType4

25

City

26

ConfirmationEmail

27

ConfirmationFax

28

ConfirmationFile

29

ConfirmationKit

30

ConfirmationPrint

31

ConfirmationReport

32

ConfirmationType

33

Contact

34

County

35

Currency

36

DOTNumber

37

EDI204

38

EDI210

39

EDI214

40

EDIValidate

41

EFT

42

EmailAddress

43

Expirations

44

ExternalEquipmentInterval

45

ExternalEquipmentMaxCount

46

ExternalEquipmentWarning

47

Fax

48

FederalID

49

GPClass

50

HazMat

51

LastActivity

52

MCNumber

53

PayTo

54

RegionType

55

SCACCode

56

SecondaryPhone

57

ServiceRating

58

TenderBy

59

Terms

60

TierRating

61

UseCashCard

62

WebAddress

63

Zip

Carrier Criteria object

To condense the information in the 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

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