Stop object :: SystemsLink

Stop properties and column mapping

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

s = stops
m = manpowerprofile
e = event

	Property	Database Column
	Name	Data Type (in C#)	Name	Data Type	Modifiable	Comments
1	Address1	string	s.stp_address	varchar(40)	Insert/Update
2	Address2	string	s.stp_address2	varchar(40)	Insert/Update
3	ArrivalDate	DateTime	s.stp_arrivaldate	datetime	Insert/Update
4	Arrived	bool	s.stp_status	varchar(6)	Insert/Update
5	Carrier	string	e.evt_carrier	varchar(8)	Insert/Update	Retrieved from Event table
6	City	int	s.stp_city	int	Insert/Update
7	Comment	string	s.stp_comment	varchar(254)	Insert/Update
8	CompanyID	string	s.cmp_id	varchar(8)	Insert/Update
9	CompanyName	string	s.cmp_name	varchar(30)	Read-only
10	Completed	bool	s.stp_departure_status	varchar(6)	Insert/Update
11	DataSourceID	string			N/A	Not mapped
12	DepartureDate	DateTime	s.stp_departuredate	datetime	Insert/Update
13	Driver1	string	e.evt_driver1	varchar(8)	Insert/Update	Join Event table
14	Driver1Name	string	m.mpp_lastfirst	varchar(45)	Read-only	Join Manpowerprofile table
15	Driver2	string	e.evt_driver2	varchar(8)	Insert/Update	Join Event table
16	Driver2Name	string	m.mpp_lastfirst	varchar(45)	Read-only	Join Manpowerprofile table
17	EarliestDate	DateTime	s.stp_schdtearliest	datetime	Insert/Update
18	EventCode	string	e.evt_eventcode	varchar(6)	Insert/Update	Retrieved from Event table
19	Freights	List<Freight>			Insert/Update	Reference Freight object from Freight table
20	IsDirty	bool			N/A	Not mapped or used in service
21	IsNew	bool			N/A	Not mapped, set to false during save to update
22	IsValid	bool			N/A	Not mapped or used in service
23	LatestDate	DateTime	s.stp_schdtlatest	datetime	Insert/Update
24	lgh_number	int	s.lgh_number	int	Read-only
25	MoveNumber	int	s.mov_number	int	Read-only
26	ord_hdrnumber	int	s.ord_hdrnumber	int	Read-only
27	PhoneNumber	string	s.stp_phonenumber	varchar(20)	Insert/Update
28	PhoneNumber2	string	s.stp_phonenumber2	varchar(20)	Insert/Update
29	ReasonLate	string	s.stp_reasonlate	varchar(6)	Insert/Update
30	ReferenceNumbers	List<ReferenceNumber>			Insert/Update	Reference ReferenceNumber object from ReferenceNumber table
31	Sequence	int	s.stp_mfh_sequence	int	Insert/Update
32	State	string	s.stp_state	varchar(6)	Insert/Update
33	StopNumber	int	s.stp_number	int	Read-only	System-generated Required for update
34	StopType	string			Read-only
35	Tractor	string	e.evt_tractor	varchar(8)	Insert/Update	Join Event table
36	Trailer2	string	e.evt_trailer2	varchar(13)	Insert/Update	Join Event table
37	TrailerID	string	e.evt_trailer1	varchar(13)	Insert/Update	Join Event table
38	UpdateableProperties	StopUpdateInfo			N/A	Not mapped
39	UseCity	bool			Insert/Update	Not used in service
40	UseCompanyAddress	bool			Insert/Update	Not used in service
41	ZipCode	string	s.stp_zipcode	varchar(10)	Insert/Update

Property

Database Column

Name

Data Type (in C#)

Name

Data Type

Modifiable

Comments

1

Address1

string

s.stp_address

varchar(40)

Insert/Update

2

Address2

string

s.stp_address2

varchar(40)

Insert/Update

3

ArrivalDate

DateTime

s.stp_arrivaldate

datetime

Insert/Update

4

Arrived

bool

s.stp_status

varchar(6)

Insert/Update

5

Carrier

string

e.evt_carrier

varchar(8)

Insert/Update

Retrieved from Event table

6

City

int

s.stp_city

int

Insert/Update

7

Comment

string

s.stp_comment

varchar(254)

Insert/Update

8

CompanyID

string

s.cmp_id

varchar(8)

Insert/Update

9

CompanyName

string

s.cmp_name

varchar(30)

Read-only

10

Completed

bool

s.stp_departure_status

varchar(6)

Insert/Update

11

DataSourceID

string

N/A

Not mapped

12

DepartureDate

DateTime

s.stp_departuredate

datetime

Insert/Update

13

Driver1

string

e.evt_driver1

varchar(8)

Insert/Update

Join Event table

14

Driver1Name

string

m.mpp_lastfirst

varchar(45)

Read-only

Join Manpowerprofile table

15

Driver2

string

e.evt_driver2

varchar(8)

Insert/Update

Join Event table

16

Driver2Name

string

m.mpp_lastfirst

varchar(45)

Read-only

Join Manpowerprofile table

17

EarliestDate

DateTime

s.stp_schdtearliest

datetime

Insert/Update

18

EventCode

string

e.evt_eventcode

varchar(6)

Insert/Update

Retrieved from Event table

19

Freights

List<Freight>

Insert/Update

Reference Freight object from Freight table

20

IsDirty

bool

N/A

Not mapped or used in service

21

IsNew

bool

N/A

Not mapped, set to false during save to update

22

IsValid

bool

N/A

Not mapped or used in service

23

LatestDate

DateTime

s.stp_schdtlatest

datetime

Insert/Update

24

lgh_number

int

s.lgh_number

int

Read-only

25

MoveNumber

int

s.mov_number

int

Read-only

26

ord_hdrnumber

int

s.ord_hdrnumber

int

Read-only

27

PhoneNumber

string

s.stp_phonenumber

varchar(20)

Insert/Update

28

PhoneNumber2

string

s.stp_phonenumber2

varchar(20)

Insert/Update

29

ReasonLate

string

s.stp_reasonlate

varchar(6)

Insert/Update

30

ReferenceNumbers

List<ReferenceNumber>

Insert/Update

Reference ReferenceNumber object from ReferenceNumber table

31

Sequence

int

s.stp_mfh_sequence

int

Insert/Update

32

State

string

s.stp_state

varchar(6)

Insert/Update

33

StopNumber

int

s.stp_number

int

Read-only

System-generated

Required for update

34

StopType

string

Read-only

35

Tractor

string

e.evt_tractor

varchar(8)

Insert/Update

Join Event table

36

Trailer2

string

e.evt_trailer2

varchar(13)

Insert/Update

Join Event table

37

TrailerID

string

e.evt_trailer1

varchar(13)

Insert/Update

Join Event table

38

UpdateableProperties

StopUpdateInfo

N/A

Not mapped

39

UseCity

bool

Insert/Update

Not used in service

40

UseCompanyAddress

bool

Insert/Update

Not used in service

41

ZipCode

string

s.stp_zipcode

varchar(10)

Insert/Update

Stop methods

The Return Value for all methods is Stop.ReturnObject.

Internal

	Parameters
Method Name	Name	Data type (in C#)	Stop.ReturnObject. ReturnCode	Description
NewStop	orderHeaderNumber	int	0 = successful 1000 = errors occurred	Creates a new Stop object with the specified orderheader number in memory
NewStops	orderHeaderNumber	int	0 = successful 1000 = errors occurred	Creates the specified number of new Stop objects with the specified orderheader number in memory
	total	int
GetStop	orderHeaderNumber	int	0 = successful 100 = no records found 1000 = errors occurred	Returns all Stop objects that meet the provided criteria
	stopNumber	int
UpdateStop	orderHeaderNumber	int	0 = successful 100 = validation errors occurred and updates prevented 500 = update proceeded with warnings 1000 = error occurred and updates prevented	Updates the Stop object with the specified stop number with the provided stop, when updating existing stops the operation and stop number are not used
	stp	Stop
	operation	ListOperation
	stopNumber	int
DeleteStop	orderHeaderNumber	int	0 = successful 100 = no records found 1000 = errors occurred	Deletes the specified Stop object then returns the deleted object if the deletion was successful
	stopNumber	int

Parameters

Method Name

Name

Data type (in C#)

Stop.ReturnObject.
ReturnCode

Description

NewStop

orderHeaderNumber

int

0 = successful

1000 = errors occurred

Creates a new Stop object with the specified orderheader number in memory

NewStops

orderHeaderNumber

int

0 = successful

1000 = errors occurred

Creates the specified number of new Stop objects with the specified orderheader number in memory

total

int

GetStop

orderHeaderNumber

int

0 = successful

100 = no records found

1000 = errors occurred

Returns all Stop objects that meet the provided criteria

stopNumber

int

UpdateStop

orderHeaderNumber

int

0 = successful

100 = validation errors occurred and updates prevented

500 = update proceeded with warnings

1000 = error occurred and updates prevented

Updates the Stop object with the specified stop number with the provided stop, when updating existing stops the operation and stop number are not used

stp

Stop

operation

ListOperation

stopNumber

int

DeleteStop

orderHeaderNumber

int

0 = successful

100 = no records found

1000 = errors occurred

Deletes the specified Stop object then returns the deleted object if the deletion was successful

stopNumber

int

External

	Parameters
Method Name	Name	Data type (in C#)	Stop.ReturnObject. ReturnCode	Description
NewStop	tokenValue	string	0 = successful 1000 = errors occurred	Creates a new Stop object with the specified orderHeaderNumber in memory
	orderHeaderNumber	int
NewStops	tokenValue	string	0 = successful 1000 = errors occurred	Creates the specified number of new Stop objects with the specified orderHeaderNumber in memory
	orderHeaderNumber	int
	total	int
GetStop	tokenValue	string	0 = successful 100 = no records found 1000 = errors occurred	Returns all Stop objects that meet the provided criteria
	orderHeaderNumber	int
	stopNumber	int
UpdateStop	tokenValue	string	0 = successful 100 = validation errors occurred and updates prevented 500 = update proceeded with warnings 1000 = error occurred and updates prevented	Updates the Stop object with the specified stop number with the provided stop, when updating existing stops the operation and stop number are not used
	orderHeaderNumber	int
	stp	Stop
	operation	ListOperation
	stopNumber	int
DeleteStop	tokenValue	string	0 = successful 100 = no records found 1000 = errors occurred	Deletes the specified Stop object then returns the deleted object if the deletion was successful
	orderHeaderNumber	int
	stopNumber	int

Parameters

Method Name

Name

Data type (in C#)

Stop.ReturnObject.
ReturnCode

Description

NewStop

tokenValue

string

0 = successful

1000 = errors occurred

Creates a new Stop object with the specified orderHeaderNumber in memory

orderHeaderNumber

int

NewStops

tokenValue

string

0 = successful

1000 = errors occurred

Creates the specified number of new Stop objects with the specified orderHeaderNumber in memory

orderHeaderNumber

int

total

int

GetStop

tokenValue

string

0 = successful

100 = no records found

1000 = errors occurred

Returns all Stop objects that meet the provided criteria

orderHeaderNumber

int

stopNumber

int

UpdateStop

tokenValue

string

0 = successful

100 = validation errors occurred and updates prevented

500 = update proceeded with warnings

1000 = error occurred and updates prevented

Updates the Stop object with the specified stop number with the provided stop, when updating existing stops the operation and stop number are not used

orderHeaderNumber

int

stp

Stop

operation

ListOperation

stopNumber

int

DeleteStop

tokenValue

string

0 = successful

100 = no records found

1000 = errors occurred

Deletes the specified Stop object then returns the deleted object if the deletion was successful

orderHeaderNumber

int

stopNumber

int

Stop.ReturnObject

	Property Name	Data Type (in C#)
1	ErrorMessages	List<string>
2	ErrorObjectIndexList	List<int>
3	Exceptions	List<Exception>
4	ReferenceObjects	List<Stop>
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<Stop>

5

ReturnCode

int

6

TraceMessages

List<string>

7

WarningMessages

List<string>

StopUpdateInfo object

Data types (in C#) for all properties are bool.
Set the property to true to update the corresponding Stop property.

	Property Name
1	Address1
2	Address2
3	ArrivalDate
4	Arrived
5	Carrier
6	City
7	Comment
8	CompanyID
9	Completed
10	DepartureDate
11	Driver1
12	Driver2
13	EarliestDate
14	EventCode
15	Freights
16	LatestDate
17	PhoneNumber
18	PhoneNumber2
19	ReasonLate
20	ReferenceNumbers
21	Sequence
22	State
23	Tractor
24	Trailer2
25	TrailerID
26	UseCitys
27	UseCompanyAddresss
28	ZipCode

Stop Criteria object

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

s = stop

	Name	Database Column	Data Type (in C#)
1	lgh_number	s.lgh_number	int?
2	MoveNumber	s.mov_number	int?
3	ord_hdrnumber	s.ord_hdrnumber	int?
4	StopNumber	s.stp_number	int?

Name

Database Column

Data Type (in C#)

Comments

1

lgh_number

s.lgh_number

int?

2

MoveNumber

s.mov_number

int?

3

ord_hdrnumber

s.ord_hdrnumber

int?

4

StopNumber

s.stp_number

int?