ReferenceNumberInOrder 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#)

NewReferenceNumberInOrder

orderHeaderNumber

Int

0 = successful

1000 = errors occurred

Creates a new ReferenceNumber object with the specified reference table and reference table key in memory

referenceTable

ReferenceNumberTable

referenceTableKey

Int

NewReferenceNumbersInOrder

orderHeaderNumber

Int

0 = successful

1000 = errors occurred

Creates the specified number of new ReferenceNumber objects with the specified reference table and reference table key in memory.

referenceTable

ReferenceNumberTable

referenceTableKey

Int

total

Int

RetrieveReferenceNumbersInOrder

orderHeaderNumber

Int

0 = successful

100 = no records found

1000 = errors occurred

Retrieves the ReferenceNumber objects that meet the provided criteria

referenceTable

ReferenceNumberTable

referenceTableKey

Int

SaveReferenceNumberInOrder

orderHeaderNumber

Int

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

referenceNumbers

List <ReferenceNumber>

updateDB

bool

DeleteReferenceNumberInOrder

orderHeaderNumber

Int

0 = successful

1000 = errors occurred

Deletes the specified ReferenceNumber object from the specified order

referenceTable

ReferenceNumberTable

referenceTableKey

Int

referenceNumberID

Int

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

Insert/Update

Not mapped

2

ID

int

r.ref_id

int

Insert/Update

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

OrderHeaderNumber

int

r.ord_hdrnumber

int

Insert/Update

6

ReferenceTable

string

r.ref_table

varchar(18)

Insert/Update

7

ReferenceTableKey

int

r.ref_tablekey

int

Insert/Update

8

ReferenceType

string

r.ref_type

varchar(6)

Insert/Update

9

UpdateableProperties

ReferenceNumberUpdateInfo

N/A

Not mapped

10

Value

string

r.ref_number

varcvhar(30)

Insert/Update

ReferenceNumberInOrder.ReturnObject

This object does not have its own ReturnObject. Use the ReferenceNumber.ReturnObject.

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