ReferenceNumber object

First available in 2014.2.

For External SystemsLink for TMWSuite use only.

External methods

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

Name

Data type (in C#)

NewReferenceNumber

tokenValue

string

0 = successful

1000 = errors occurred

Authenticates the token value and creates a new ReferenceNumber object in memory

RetrieveReferenceNumbers

tokenValue

string

0 = successful

100 = no records found

1000 = errors occurred

Authenticates the token value and retrieves all ReferenceNumber objects that meet the provided criteria

criteria

ReferenceNumber.Criteria

SaveReferenceNumber

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

referenceNumbers

List<ReferenceNumber>

updateDB

bool

DeleteReference

tokenValue

string

0 = successful

1000 = errors occurred

Authenticates the token value and deletes the ReferenceNumber object that meets the provided criteria

referenceNumberID

Int