CarrierAuction object

First available in SystemsLink: 2015.2.0 SP1

Methods

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

Name

Data type (in C#)

NewCarrierAuction

N/A

CarrierAuction.ReturnObject.ReturnCode

0 = successful

1000 = errors occurred

Returns new CarrierAuction object instance

NewCarrierAuctions

number

int

CarrierAuction.ReturnObject.ReturnCode

0 = successful

1000 = errors occurred

Returns new CarrierAuction object instances

RetrieveCarrierAuction

criteria

CarrierAuction.Criteria

CarrierAuction.ReturnObject.ReturnCode

0 = successful

100 = no records found

1000 = errors occurred

Creates a new CarrierAuction object in memory

RetrievePagedCarrierAuctions

criteria

CarrierAuction.Criteria

CarrierAuction.PagedReturnObject.ReturnCode

0 = successful

100 = no records found

1000 = errors occurred

Retrieves CarrierAuctions based on passed-in criteria and paging

SaveCarrierAuction

items

List<CarrierAuction>

CarrierAuction.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 CarrierAuction objects and updates the database if requested, then returns the saved objects if the save was successful

updateDB

bool

Properties and column mapping

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

c = carrierauctions

Property Database Column Modifiable Comments

Name

Data Type (in C#)

Name

Data Type

1

AuctionAmount

double

c.ca_auction_amount

money

Insert / Update

2

CgpType

string

c.cgp_type

varchar(6)

Insert / Update

3

ClcRating

string

c.clc_car_rating

varchar(12)

Insert / Update

4

ClcRatingAndHigher

string

c.clc_rating_and_higher

char(1)

Insert / Update

5

CreatedDate

DateTime

c.created_date

datetime

Read only

6

CreatedUser

string

c.created_user

varchar(20)

Read only

7

DataSourceID

string

Not mapped

8

Description

string

c.ca_description

varchar(255)

Insert / Update

9

EndDate

DateTime

c.ca_end_date

datetime

Insert / Update

10

Id

int

c.ca_id

int

Read only

11

IsDirty

bool

Not mapped

12

IsNew

bool

Not mapped

13

IsValid

bool

Not mapped

14

LaneId

int

c.laneid

int

Insert / Update

15

LghNumber

int

c.lgh_number

int

Insert / Update

16

LoadDestearliest

DateTime

c.ca_load_destearliest

datetime

Insert / Update

17

LoadDestlatest

DateTime

c.ca_load_destlatest

datetime

Insert / Update

18

LoadOriginearliest

DateTime

c.ca_load_origine arliest

datetime

Insert / Update

19

LoadOriginlatest

DateTime

c.ca_load_originlatest

datetime

Insert / Update

20

Message

string

c.ca_message

varchar(2000)

Insert / Update

21

ModifiedDate

DateTime

c.modified_date

datetime

Read only

22

ModifiedUser

string

c.modified_user

varchar(20)

Read only

23

OrdHdrNumber

int

c.ord_hdrnumber

int

Insert / Update

24

Rating

string

c.car_rating

varchar(12)

Insert / Update

25

RatingAndHigher

string

c.car_rating_and_higher

char(1)

Insert / Update

26

SendFromServer

string

c.ca_send_from_server

char(1)

Insert / Update

27

SendSequentially

string

c.ca_send_sequentially

char(1)

Insert / Update

28

SendSequentially1

int

c.ca_send_sequentially1

int

Insert / Update

29

SendSequentially2

int

c.ca_send_sequentially2

int

Insert / Update

30

SendSequentially3

int

c.ca_send_sequentially3

int

Insert / Update

31

SendSequentially4

int

c.ca_send_sequentially4

int

Insert / Update

32

SendVia

string

c.ca_send_via

varchar(6)

Insert / Update

33

Status

string

c.ca_status

varchar(6)

Insert / Update

34

Type

string

c.ca_type

varchar(6)

Insert / Update

35

UpdateableProperties

CarrierAuctionUpdateInfo

CarrierAuction.ReturnObject

Property Name Data Type (in C#) Comments

1

ErrorMessages

List<string>

2

ErrorObjectIndexList

List<int>

3

Exceptions

List<Exception>

4

ReferenceObjects

List<CarrierAuction>

5

ReturnCode

int

6

TraceMessages

List<string>

7

WarningMessages

List<string>

CarrierAuction.PagedReturnObject

Property Name Data Type (in C#) Comments

1

PageIndex

int

2

PageSize

int

3

TotalRecords

int

CarrierAuctionUpdateInfo object

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

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

Property Name Comments

1

AuctionAmount

2

CgpType

3

ClcRating

4

ClcRatingAndHigher

5

Description

6

EndDate

7

LaneId

8

LghNumber

9

LoadDestearliest

10

LoadDestlatest

11

LoadOriginearliest

12

LoadOriginlatest

13

Message

14

OrdHdrNumber

15

Rating

16

RatingAndHigher

17

SendFromServer

18

SendSequentially

19

SendSequentially1

20

SendSequentially2

21

SendSequentially3

22

SendSequentially4

23

SendVia

24

Status

25

Type

Criteria object

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

c = carrierauctions

Name Database Column Data Type (in C#) Comments

1

Ascending

bool?

Not mapped

2

AuctionAmount

c.ca_auction_amount

double?

3

CgpType

c.cgp_type

string

4

ClcRating

c.clc_car_rating

string

5

ClcRatingAndHigher

c.clc_rating_and_higher

string

6

CreatedDate

c.created_date

DateTime?

7

CreatedUser

c.created_user

string

8

Description

c.ca_description

string

9

EndDate

c.ca_end_date

DateTime?

10

Expressions

List<CriteriaExpression>

11

Id

c.ca_id

int?

12

LaneId

c.laneid

int?

13

LegRevenue

double?

Not mapped

14

LghNumber

c.lgh_number

int?

15

LoadDestearliest

c.ca_load_destearliest

DateTime?

16

LoadDestlatest

c.ca_load_destlatest

DateTime?

17

LoadOriginearliest

c.ca_load_origine arliest

DateTime?

18

LoadOriginlatest

c.ca_load_originlatest

DateTime?

19

Message

c.ca_message

string

20

ModifiedDate

c.modified_date

DateTime?

21

ModifiedUser

c.modified_user

string

22

OrdHdrNumber

c.ord_hdrnumber

int?

23

PagingData

PagingData

Not mapped

24

Rating

c.car_rating

string

25

RatingAndHigher

c.car_rating_and_higher

string

26

SendFromServer

c.ca_send_from_server

string

27

SendVia

c.ca_send_via

string

28

Settings

CriteriaSettings

29

SortBy

String

Not mapped

30

Status

c.ca_status

string

31

Type

c.ca_type

string

CriteriaSettings object

Name Comments

1

AuctionAmount

2

CgpType

3

ClcRating

4

ClcRatingAndHigher

5

CreatedDate

6

CreatedUser

7

Description

8

EndDate

9

Id

10

LaneId

11

LegRevenue

12

LghNumber

13

LoadDestearliest

14

LoadDestlatest

15

LoadOriginearliest

16

LoadOriginlatest

17

Message

18

ModifiedDate

19

ModifiedUser

20

OrdHdrNumber

21

Rating

22

RatingAndHigher

23

SendFromServer

24

SendVia

25

Status

26

Type

CriteriaExpression object

Name Data Type (in C#) Comments

1

Conjuction

CriteriaSetting.ConjuctionEnum

2

Criteria

Criteria