Freight object :: SystemsLink

Freight 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
	Name	Data Type (in C#)	Name	Data Type	Modifiable	Comments
1	AccountOf	string	f.fgt_accountof	varchar(8)	Insert/Update
2	ActualQuantity	decimal	f.fgt_quantity	float	Insert/Update	First available in 2015.1.0
3	CmdCode	string	f.cmd_code	varchar(8)	Insert/Update
4	CmdDescripton	string	f.fgt_description (defaults to the value in commodity.cmd_name)	varchar(60)	Insert/Update
5	Count	double	f.fgt_count	decimal(10,2)	Insert/Update
6	CountUnit	string	f.fgt_countunit	varchar(6)	Insert/Update
7	DataSourceID	string			N/A	Not mapped
8	FreightNumber	int	f.fgt_number	int	Read-only	System-generated
9	Height	double	f.fgt_height	float	Insert/Update
10	HeightUnit	string	f.fgt_heightunit	varchar(6)	Insert/Update
11	HiTemp	short	f.fgt_hitemp	smallint	Insert/Update
12	IsDirty	bool			N/A	Not mapped or used in service
13	IsNew	bool			N/A	Not mapped, set to false during save to update
14	IsValid	bool			N/A	Not mapped or used in service
15	Length	double	f.fgt_length	Float	Insert/Update
16	LengthUnit	string	f.fgt_lengthunit	varchar(6)	Insert/Update
17	LowTemp	short	f.fgt_lowtemp	smallint	Insert/Update
18	NetQuantity	double	f.fgt_volume2	float	Insert/Update	First available in 2015.1.0
19	ParentFreightNumber	int	f.fgt_parentcmd_fgt_number	int	Insert/Update
20	ReferenceNumbers	List<ReferenceNumber>			Insert/Update	Reference ReferenceNumber object in ReferenceNumber table
21	Sequence	int	f.fgt_display_sequence	int	Insert/Update
22	Shipper	string	f.fgt_shipper	char(8)	Insert/Update
23	StopNumber	int	f.stp_number	int	Read-only	System-managed
24	Supplier	string	f.fgt_supplier	varchar(8)	Insert/Update
25	UpdateableProperties	FreightUpdateInfo			N/A	Not mapped
26	Volume	double	f.fgt_volume	float	Insert/Update
27	VolumeUnit	string	f.fgt_volumeunit	varchar(6)	Insert/Update
28	Weight	double	f.fgt_weight	float	Insert/Update
29	WeightUnit	string	f.fgt_weightunit	varchar(6)	Insert/Update
30	Width	double	f.fgt_width	float	Insert/Update
31	WidthUnit	string	f.fgt_widthunit	varchar(6)	Insert/Update

Property

Database Column

Name

Data Type (in C#)

Name

Data Type

Modifiable

Comments

1

AccountOf

string

f.fgt_accountof

varchar(8)

Insert/Update

2

ActualQuantity

decimal

f.fgt_quantity

float

Insert/Update

First available in 2015.1.0

3

CmdCode

string

f.cmd_code

varchar(8)

Insert/Update

4

CmdDescripton

string

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

varchar(60)

Insert/Update

5

Count

double

f.fgt_count

decimal(10,2)

Insert/Update

6

CountUnit

string

f.fgt_countunit

varchar(6)

Insert/Update

7

DataSourceID

string

N/A

Not mapped

8

FreightNumber

int

f.fgt_number

int

Read-only

System-generated

9

Height

double

f.fgt_height

float

Insert/Update

10

HeightUnit

string

f.fgt_heightunit

varchar(6)

Insert/Update

11

HiTemp

short

f.fgt_hitemp

smallint

Insert/Update

12

IsDirty

bool

N/A

Not mapped or used in service

13

IsNew

bool

N/A

Not mapped, set to false during save to update

14

IsValid

bool

N/A

Not mapped or used in service

15

Length

double

f.fgt_length

Float

Insert/Update

16

LengthUnit

string

f.fgt_lengthunit

varchar(6)

Insert/Update

17

LowTemp

short

f.fgt_lowtemp

smallint

Insert/Update

18

NetQuantity

double

f.fgt_volume2

float

Insert/Update

First available in 2015.1.0

19

ParentFreightNumber

int

f.fgt_parentcmd_fgt_number

int

Insert/Update

20

ReferenceNumbers

List<ReferenceNumber>

Insert/Update

Reference ReferenceNumber object in ReferenceNumber table

21

Sequence

int

f.fgt_display_sequence

int

Insert/Update

22

Shipper

string

f.fgt_shipper

char(8)

Insert/Update

23

StopNumber

int

f.stp_number

int

Read-only

System-managed

24

Supplier

string

f.fgt_supplier

varchar(8)

Insert/Update

25

UpdateableProperties

FreightUpdateInfo

N/A

Not mapped

26

Volume

double

f.fgt_volume

float

Insert/Update

27

VolumeUnit

string

f.fgt_volumeunit

varchar(6)

Insert/Update

28

Weight

double

f.fgt_weight

float

Insert/Update

29

WeightUnit

string

f.fgt_weightunit

varchar(6)

Insert/Update

30

Width

double

f.fgt_width

float

Insert/Update

31

WidthUnit

string

f.fgt_widthunit

varchar(6)

Insert/Update

Freight methods

The Return Value for all methods is Freight.ReturnObject.

Internal

	Parameters
Method Name	Name	Data type (in C#)	Freight.ReturnObject. ReturnCode	Description
NewFreight	orderHeaderNumber	int	0 = successful 1000 = errors occurred	Creates a new Freight object with the specified orderheader number and stop number in memory
	stopNumber	int
NewFreights	orderHeaderNumber	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	orderHeaderNumber	int	0 = successful 100 = no records found 1000 = errors occurred	Returns all Freight objects with the specified orderheader number, stop number, and freight number
	stopNumber	int
	freightNumber	int
UpdateFreight	orderHeaderNumber	int	0 = successful 100 = validation errors occurred and updates prevented 500 = update proceeded with warnings 1000 = error occurred and updates prevented	Updates the Freight object with the specified orderheader number, stop number, and freight number with the provided freight
	stopNumber	int
	fgt	Freight
	operation	ListOperation
	freightNumber	int
	updateDB	bool
DeleteFreight	orderHeaderNumber	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

Parameters

Method Name

Name

Data type (in C#)

Freight.ReturnObject.
ReturnCode

Description

NewFreight

orderHeaderNumber

int

0 = successful

1000 = errors occurred

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

stopNumber

int

NewFreights

orderHeaderNumber

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

orderHeaderNumber

int

0 = successful

100 = no records found

1000 = errors occurred

Returns all Freight objects with the specified orderheader number, stop number, and freight number

stopNumber

int

freightNumber

int

UpdateFreight

orderHeaderNumber

int

0 = successful

100 = validation errors occurred and updates prevented

500 = update proceeded with warnings

1000 = error occurred and updates prevented

Updates the Freight object with the specified orderheader number, stop number, and freight number with the provided freight

stopNumber

int

fgt

Freight

operation

ListOperation

freightNumber

int

updateDB

bool

DeleteFreight

orderHeaderNumber

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

External

	Parameters
Method Name	Name	Data type (in C#)	Freight.ReturnObject. ReturnCode	Description
NewFreight	tokenValue	string	0 = successful 1000 = errors occurred	Creates a new Freight object with the specified orderheader number and stop number in memory
	orderHeaderNumber	int
	stopNumber	int
NewFreights	tokenValue	string	0 = successful 1000 = errors occurred	Creates the specified number of new Freight objects with the specified orderheader number and stop number in memory
	orderHeaderNumber	int
	stopNumber	int
	total	int
GetFreight	tokenValue	string	0 = successful 100 = no records found 1000 = errors occurred	Returns all Freight objects with the specified orderheader number, stop number, and freight number
	orderHeaderNumber	int
	stopNumber	int
	freightNumber	int
UpdateFreight	tokenValue	string	0 = successful 100 = validation errors occurred and updates prevented 500 = update proceeded with warnings 1000 = error occurred and updates prevented	Updates the Freight object with the specified orderheader number, stop number, and freight number with the provided freight
	orderHeaderNumber	int
	stopNumber	int
	fgt	Freight
	operation	ListOperation
	freightNumber	int
	updateDB	bool
DeleteFreight	tokenValue	string	0 = successful 100 = no records found 1000 = errors occurred	Deletes the Freight object with the provided orderheader number, stop number, and freight number
	orderHeaderNumber	int
	stopNumber	int
	freightNumber	int

Parameters

Method Name

Name

Data type (in C#)

Freight.ReturnObject.
ReturnCode

Description

NewFreight

tokenValue

string

0 = successful

1000 = errors occurred

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

orderHeaderNumber

int

stopNumber

int

NewFreights

tokenValue

string

0 = successful

1000 = errors occurred

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

orderHeaderNumber

int

stopNumber

int

total

int

GetFreight

tokenValue

string

0 = successful

100 = no records found

1000 = errors occurred

Returns all Freight objects with the specified orderheader number, stop number, and freight number

orderHeaderNumber

int

stopNumber

int

freightNumber

int

UpdateFreight

tokenValue

string

0 = successful

100 = validation errors occurred and updates prevented

500 = update proceeded with warnings

1000 = error occurred and updates prevented

Updates the Freight object with the specified orderheader number, stop number, and freight number with the provided freight

orderHeaderNumber

int

stopNumber

int

fgt

Freight

operation

ListOperation

freightNumber

int

updateDB

bool

DeleteFreight

tokenValue

string

0 = successful

100 = no records found

1000 = errors occurred

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

orderHeaderNumber

int

stopNumber

int

freightNumber

int

Freight.ReturnObject

	Property Name	Data Type (in C#)
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>

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	AccountOf
2	CmdCode
3	CmdDescripton
4	Count
5	CountUnit
6	Height
7	HeightUnit
8	HiTemp
9	Length
10	LengthUnit
11	LowTemp
12	ReferenceNumbers
13	Shipper
14	Sequence
15	Supplier
16	Volume
17	VolumeUnit
18	Weight
19	WeightUnit
20	Width
21	WidthUnit

Freight Criteria object

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

f = freightdetail

	Name	Database Column	Data Type (in C#)	Comments
1	FreightNumber	f.fgt_number	int?
2	StopNumber	f.stp_number	int?

Name

Database Column

Data Type (in C#)

Comments

1

FreightNumber

f.fgt_number

int?

2

StopNumber

f.stp_number

int?