ReferenceNumber object

First available in SystemsLink: 2014.2

Used by External SystemsLink for TMWSuite.

Methods

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

Name

Data type (in C#)

NewReferenceNumber

N/A

0 = successful

1000 = errors occurred

Creates a new ReferenceNumber object in memory

RetrieveReferenceNumbers

criteria

ReferenceNumber.Criteria

0 = successful

100 = no records found

1000 = errors occurred

Retrieves all ReferenceNumber objects that meet the provided criteria

SaveReferenceNumber

referenceNumbers

List<ReferenceNumber>

0 = successful

100 = validation errors occurred and updates prevented

500 = update proceeded with warnings

1000 = error occurred and updates prevented

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

updateDB

bool

DeleteReferenceNumber

referenceNumberID

Int

0 = successful

1000 = errors occurred

Deletes the ReferenceNumber object that meets the provided criteria

Properties and column mapping

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

r = referencenumber
Property Database Column Modifiable Comments

Name

Data Type (in C#)

Name

Data Type

1

DataSourceID

string

N/A

Not mapped

2

ID

int

r.ref_id

int

Read only

System-controlled

3

IsDirty

bool

N/A

Not mapped or used in service

4

IsNew

bool

N/A

Not mapped, set to false during save to update

5

IsValid

bool

N/A

Not mapped or used in service

6

OrderHeaderNumber

int

r.ord_hdrnumber

int

Insert/Update

7

ReferenceTable

string

r.ref_table

varchar(18)

Insert/Update

System-generated, default=Stops

8

ReferenceTableKey

int

r.ref_tablekey

int

Insert/Update

System-generated

9

ReferenceType

string

r.ref_type

varchar(6)

Insert/Update

10

UpdateableProperties

ReferenceNumberUpdateInfo

N/A

Not mapped

11

Value

string

r.ref_number

varcvhar(30)

Insert/Update

ReferenceNumber.ReturnObject

Property Name Data Type (in C#) Comments

1

ErrorMessages

List <string>

2

ErrorObjectIndexList

List <int>

3

Exceptions

List <Exception>

4

ReferenceObjects

List <ReferenceNumber>

5

ReturnCode

int

6

TraceMessages

List <string>

7

WarningMessages

List <string>

ReferenceNumberUpdateInfo object

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

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

1

OrderHeaderNumber

2

ReferenceTable

3

ReferenceTableKey

4

ReferenceType

5

Value

Criteria object

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

r = referencenumber
Name Database Column Data Type (in C#) Comments

1

OrderHeaderNumber

r.ord_hdrnumber

int?

2

ReferenceTable

r.ref_table

string

3

ReferenceTableKey

r.ref_tablekey

int?

4

ReferenceType

r.ref_type

string

5

Value

r.ref_number

string