Freight object

First available in SystemsLink: 2014.2

Used by External SystemsLink for TMWSuite.

Methods

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

Name

Data type (in C#)

NewFreight

orderHdrNumber

int

0 = successful

1000 = errors occurred

Creates a new Freight object with the specified orderheader number and stop number in memory

stopNumber

int

NewFreights

orderHdrNumber

int

0 = successful

1000 = errors occurred

Creates the specified number of new Freight objects with the specified orderheader number and stop number in memory

stopNumber

int

total

int

GetFreight

orderHdrNumber

int

0 = successful

100 = no records found

1000 = errors occurred

Returns the Freight object with the specified orderheader number, stop number, and freight number

stopNumber

int

freightNumber

int

UpdateFreight

orderHdrNumber

int

0 = successful

100 = validation errors occurred and updates prevented

500 = update proceeded with warnings

1000 = error occurred and updates prevented

Saves the Freight object and updates the database if requested, then returns the saved objects if the save was successful

stopNumber

fgt

Freight

operation

ListOperation

freightNumber

int

DeleteFreight

orderHdrNumber

int

0 = successful

100 = no records found

1000 = errors occurred

Deletes the Freight object with the provided orderheader number, stop number, and freight number

stopNumber

int

freightNumber

int

Properties and column mapping

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

f = freightdetail
Property Database Column Modifiable Comments

Name

Data Type (in C#)

Name

Data Type

1

ActualQuantity

decimal

f.fgt_actual_quantity.

float

Insert/Update

First available in SystemsLink: 2015.1.0

2

CmdCode

string

f.cmd_code

varchar(8)

Insert/Update

3

CmdDescripton

string

f.fgt_description (defaults to the value in commodity.cmd_name)

varchar(60)

Insert/Update

4

Count

double

f.fgt_count

decimal(10,2)

Insert/Update

5

CountUnit

string

f.fgt_countunit

varchar(6)

Insert/Update

6

CountUnitDisplay

string

Read only

Not mapped

7

DataSourceID

string

N/A

Not mapped

8

fgt_asset

string

f.fgt_asset

varchar(13)

Insert/Update

New column

9

FreightNumber

int

f.fgt_number

int

Read only

System-generated

10

Height

double

f.fgt_height

float

Insert/Update

11

HeightUnit

string

f.fgt_heightunit

varchar(6)

Insert/Update

12

HeightUnitDisplay

string

Read only

Not mapped

13

HiTemp

short

f.fgt_hitemp

smallint

Insert/Update

14

IsDirty

bool

N/A

Not mapped or used in service

15

IsNew

bool

N/A

Not mapped, set to false during save to update

16

IsValid

bool

N/A

Not mapped or used in service

17

Length

double

f.fgt_length

Float

Insert/Update

18

LengthUnit

string

f.fgt_lengthunit

varchar(6)

Insert/Update

19

LengthUnitDisplay

string

Read only

Not mapped

20

LowTemp

short

f.fgt_lowtemp

smallint

Insert/Update

21

ReferenceNumbers

List <ReferenceNumber>

Insert/Update

Reference ReferenceNumber object in reference number table

22

Sequence

int

f.fgt_display_sequence

int

Insert/Update

23

StopNumber

int

f.stp_number

int

Read only

System-managed

24

UpdateableProperties

FreightUpdateInfo

N/A

Not mapped

25

Volume

double

f.fgt_volume

float

Insert/Update

26

VolumeUnit

string

f.fgt_volumeunit

varchar(6)

Insert/Update

27

VolumeUnitDisplay

string

Read only

Not mapped

28

Weight

double

f.fgt_weight

float

Insert/Update

29

WeightUnit

string

f.fgt_weightunit

varchar(6)

Insert/Update

30

WeightUnitDisplay

string

Read only

Not mapped

31

Width

double

f.fgt_width

float

Insert/Update

32

WidthUnit

string

f.fgt_widthunit

varchar(6)

Insert/Update

33

WidthUnitDisplay

string

Read only

Not mapped

Freight.ReturnObject

Property Name Data Type (in C#) Comments

1

ErrorMessages

List <string>

2

ErrorObjectIndexList

List <int>

3

Exceptions

List <Exception>

4

ReferenceObjects

List <Freight>

5

ReturnCode

int

6

TraceMessages

List <string>

7

WarningMessages

List <string>

FreightUpdateInfo object

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

  • Set the property to true to update the corresponding Freight property.
Property Name

1

CmdCode

2

CmdDescripton

3

Count

4

CountUnit

5

fgt_asset

6

Height

7

HeightUnit

8

HiTemp

9

Length

10

LengthUnit

11

LowTemp

12

ReferenceNumbers

13

Sequence

14

Volume

15

VolumeUnit

16

Weight

17

WeightUnit

18

Width

19

WidthUnit

Criteria object

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

f = freightdetail
Name Database Column Data Type (in C#) Comments

1

fgt_asset

f.fgt_asset

string

2

FreightNumber

f.fgt_number

int?

3

StopNumber

f.stp_number

int?