ReferenceNumberInOrder object

First available in 2014.2.

For External SystemsLink for TMWSuite use only.

External methods

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

Name

Data type (in C#)

NewReferenceNumberInOrder

tokenValue

string

0 = successful

1000 = errors occurred

Authenticates the token value and creates a new ReferenceNumberInOrder object with the specified orderheader number in memory

orderHdrNumber

Int

referenceTable

ReferenceNumberTable

referenceTableKey

Int

NewReferenceNumbersInOrder

tokenValue

string

0 = successful

1000 = errors occurred

Authenticates the token value and creates the specified number of new ReferenceNumberInOrder objects with the specified orderheader number in memory

orderHdrNumber

Int

referenceTable

ReferenceNumberTable

referenceTableKey

Int

total

Int

RetrieveReferenceNumbersInOrder

tokenValue

string

0 = successful

100 = no records found

1000 = errors occurred

Authenticates the token value and retrieves the ReferenceNumberInOrder objects that meet the provided criteria

orderHdrNumber

Int

referenceTable

ReferenceNumberTable

referenceTableKey

Int

SaveReferenceNumberInOrder

tokenValue

string

0 = successful

100 = validation errors occurred and updates prevented

500 = update proceeded with warnings

1000 = error occurred and updates prevented

Authenticates the token value, saves the provided ReferenceNumberInOrder objects, and updates the database if requested, then returns the saved objects if the save was successful

orderHdrNumber

Int

referenceNumbers

List <ReferenceNumber>

updateDB

bool

DeleteReferenceNumberInOrder

tokenValue

string

0 = successful

1000 = errors occurred

Authenticates the token value and deletes the specified ReferenceNumberInOrder object from the specified order

orderHdrNumber

Int

referenceTable

ReferenceNumberTable

referenceTableKey

Int

referenceNumberID

Int