CheckCall object

First available in SystemsLink: 2014.2

Used by External SystemsLink for TMWSuite.

Methods

Method Name Parameters ReturnCode Description

Name

Data type (in C#)

NewCheckCall

N/A

CheckCall.ReturnObject.ReturnCode

0 = successful

1000 = errors occurred

Creates a new CheckCall object in memory

NewCheckCalls

total

int

CheckCall.ReturnObject.ReturnCode

0 = successful

1000 = errors occurred

Creates the specified number of new CheckCall objects in memory

SaveCheckCall

checkcalls

List CheckCall>

CheckCall.ReturnObject.ReturnCode

0 = successful

100 = validation errors occurred and updates prevented

500 = update proceeded with warnings

1000 = error occurred and updates prevented

Saves the provided CheckCall objects and updates the database if requested, then returns the saved objects if the save was successful

updateDB

bool

DeleteCheckCall

checkCallNumber

int

CheckCall.ReturnObject.ReturnCode

0 = successful

100 = no records found

1000 = errors occurred

Deletes the CheckCall with the provided CheckCallNumber

RetrievePagedCheckCalls

criteria

CheckCall.Criteria

CheckCall.PagedReturnObject.ReturnCode

0 = successful

100 = no records found

1000 = errors occurred

Returns all CheckCall objects in a paged format that meet the provided criteria

pagingData

PagingData

Properties and column mapping

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

c = checkcall

Property Database Column Modifiable Comments

Name

Data Type (in C#)

Name

Data Type

1

Asgnid

string

c.ckc_asgnid

varchar(13)

Insert/Update

2

Asgntype

CheckcallAssignTypeEnum

c.ckc_asgntype

char(6)

Insert/Update

3

CheckCallNumber

int

c.ckc_number

int

ReadOnly

4

City

int

c.ckc_city

int

Insert/Update

5

CityName

string

city.cty_name

varchar(18)

Insert/Update

6

Comment

string

c.ckc_comment

char(255)

Insert/Update

7

CommentLarge

string

c.ckc_commentlarge

varchar(254)

Insert/Update

8

DataSourceID

string

N/A

9

DateOfCall

DateTime

c.ckc_date

datetime

Insert/Update

10

DateOnly

DateTime

Insert/Update

11

DirectionFrom

string

c.ckc_directionfrom

char(3)

Insert/Update

12

EventCode

string

c.ckc_event

char(6)

Insert/Update

13

ExtraData01

string

c.ckc_ExtraData01

varchar(255)

Insert/Update

14

ExtraData02

string

c.ckc_ExtraData02

varchar(255)

Insert/Update

15

ExtraData03

string

c.ckc_ExtraData03

varchar(255)

Insert/Update

16

ExtraData04

string

c.ckc_ExtraData04

varchar(255)

Insert/Update

17

ExtraData05

string

c.ckc_ExtraData05

varchar(255)

Insert/Update

18

ExtraData06

string

c.ckc_ExtraData06

varchar(255)

Insert/Update

19

ExtraData07

string

c.ckc_ExtraData07

varchar(255)

Insert/Update

20

ExtraData08

string

c.ckc_ExtraData08

varchar(255)

Insert/Update

21

ExtraData09

string

c.ckc_ExtraData09

varchar(255)

Insert/Update

22

ExtraData10

string

c.ckc_ExtraData10

varchar(255)

Insert/Update

23

ExtraData11

string

c.ckc_ExtraData11

varchar(255)

Insert/Update

24

ExtraData12

string

c.ckc_ExtraData12

varchar(255)

Insert/Update

25

ExtraData13

string

c.ckc_ExtraData13

varchar(255)

Insert/Update

26

ExtraData14

string

c.ckc_ExtraData14

varchar(255)

Insert/Update

27

ExtraData15

string

c.ckc_ExtraData15

varchar(255)

Insert/Update

28

ExtraData16

string

c.ckc_ExtraData16

varchar(255)

Insert/Update

29

ExtraData17

string

c.ckc_ExtraData17

varchar(255)

Insert/Update

30

ExtraData18

string

c.ckc_ExtraData18

varchar(255)

Insert/Update

31

ExtraData19

string

c.ckc_ExtraData19

varchar(255)

Insert/Update

32

ExtraData20

string

c.ckc_ExtraData20

varchar(255)

Insert/Update

33

Extsensoralarm

string

c.ckc_extsensoralarm

char(1)

Insert/Update

34

Heading

single

c.ckc_heading

float

Insert/Update

35

Home

string

c.ckc_home

char(1)

Insert/Update

36

IsDirty

bool

N/A

37

IsNew

bool

N/A

38

IsValid

bool

N/A

39

LegHeaderNumber

int

c.ckc_lghnumber

int

Insert/Update

40

Longseconds

int

c.ckc_longseconds

Insert/Update

Only available in versions 14.1 and earlier

41

Mileage

int

c.ckc_mileage

int

Insert/Update

42

MilesFrom

double

c.ckc_milesfrom

float

Insert/Update

43

MilesToFinal

int

c.ckc_miles_to_final

int

Insert/Update

44

Minutes

int

c.ckc_minutes

int

Insert/Update

45

MinutesToFinal

int

c.ckc_minutes_to_final

int

Insert/Update

46

MtAvailable

string

c.ckc_mtavailable

char(1)

Insert/Update

47

Odometer

int

c.ckc_Odometer

int

Insert/Update

48

RawLatSeconds

int

c.ckc_latseconds

Insert/Update

49

RawLongSeconds

int

c.ckc_longseconds

Insert/Update

50

Speed

int

c.ckc_speed

int

Insert/Update

51

State

string

c.ckc_state

varchar(6)

Insert/Update

52

Status

string

c.ckc_status

char(6)

Insert/Update

53

SubsistenceQualified

string

c.ckc_subsistencequalified

int

Insert/Update

54

TimeOnly

DateTime

Insert/Update

55

TractorNumber

string

c.ckc_tractor

char(8)

Insert/Update

56

UpdateableProperties

CheckCallUpdateInfo

N/A

57

Updatedby

string

c.ckc_updatedby

char(20)

Insert/Update

58

Updatedon

DateTime

c.ckc_updatedon

datetime

Insert/Update

59

Validity

string

c.ckc_validity

char(6)

Insert/Update

60

VehicleIgnition

CheckcallVehicleIgnitionEnum

c.ckc_vehicleignition

char(1)

Insert/Update

61

Zip

string

c.ckc_zip

varchar(10)

Insert/Update

CheckCall.ReturnObject

Property Name Data Type (in C#) Comments

1

ErrorMessages

List <string>

2

ErrorObjectIndexList

List <int>

3

Exceptions

List <Exception>

4

ReferenceObjects

List<CheckCall>

5

ReturnCode

int

6

TraceMessages

List <string>

7

WarningMessages

List <string>

CheckCall.PagedReturnObject

Property Name Data Type (in C#) Comments

1

ErrorMessages

List <string>

2

ErrorObjectIndexList

List <int>

3

Exceptions

List <Exception>

4

PageIndex

int

5

PageSize

int

6

ReferenceObjects

List<CheckCall>

7

ReturnCode

int

8

TotalRecords

int

9

TraceMessages

List <string>

10

WarningMessages

List <string>

CheckCallUpdateInfo object

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

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

Property Name Comments

1

Asgnid

2

Asgntype

3

City

4

CityName

5

Comment

6

CommentLarge

7

DateOfCall

8

DateOnly

9

DirectionFrom

10

EventCode

11

ExtraData01

12

ExtraData02

13

ExtraData03

14

ExtraData04

15

ExtraData05

16

ExtraData06

17

ExtraData07

18

ExtraData08

19

ExtraData09

20

ExtraData10

21

ExtraData11

22

ExtraData12

23

ExtraData13

24

ExtraData14

25

ExtraData15

26

ExtraData16

27

ExtraData17

28

ExtraData18

29

ExtraData19

30

ExtraData20

31

Extsensoralarm

32

Heading

33

Home

34

Latseconds

35

LegHeaderNumber

36

Longseconds

Only available in version 14.1 and earlier

37

Mileage

38

MilesFrom

39

MilesToFinal

40

Minutes

41

MinutesToFinal

42

MtAvailable

43

Odometer

44

RawLatSeconds

45

RawLongSeconds

46

Speed

47

State

48

Status

49

SubsistenceQualified

50

TimeOnly

51

TractorNumber

52

Updatedby

53

Updatedon

54

Validity

55

VehicleIgnition

56

WorldLatSeconds

57

WorldLongSeconds

58

Zip

Criteria object

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

c = checkcall

Name Database Column Data Type (in C#) Comments

1

AsgnId

c.ckc_asgnid

string

2

Asgntype

c.ckc_asgntype

CheckcallAssignTypeEnum?

3

CheckCallNumber

c.ckc_number

int?

4

City

c.ckc_city

int?

5

CityName

city.cty_name

string

6

Comment

c.ckc_comment

string

7

DateOfCall

c.ckc_date

DateTime?

8

EventCode

c.ckc_event

string

9

Expressions

List<CriteriaExpression>

10

Home

c.ckc_home

string

11

LegHeaderNumber

c.ckc_lghnumber

int?

12

RawLatSeconds

c.ckc_latseconds

int?

13

RawLongSeconds

c.ckc_longseconds

int?

14

Settings

CriteriaSettings

15

State

c.ckc_state

string

16

Status

c.ckc_status

string

17

TractorNumber

c.ckc_tractor

string

18

Updatedby

c.ckc_updatedby

string

19

Zip

c.ckc_zip

string

CriteriaExpression

First available in SystemsLink: 2014.2

Name Data Type (in C#) Comments

1

Criteria

Criteria

2

Conjunction

CriteriaSetting.ConjunctionEnum

CriteriaSettings

First available in SystemsLink: 2014.2

Name

1

AsgnId

2

AsgnType

3

CheckCallNumber

4

City

5

CityName

6

Comment

7

DateOfCall

8

EventCode

9

Home

10

LegHeaderNumber

11

RawLatSeconds

12

RawLongSeconds

13

State

14

Status

15

TractorNumber

16

Updatedby

17

Zip