Stop object

First available in 2014.2.

For External SystemsLink for TMWSuite use only.

External methods

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

Name

Data type (in C#)

NewStop

tokenValue

string

0 = successful

1000 = errors occurred

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

orderHdrNumber

int

NewStops

tokenValue

string

0 = successful

1000 = errors occurred

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

orderHdrNumber

int

total

int

GetStop

tokenValue

string

0 = successful

100 = no records found

1000 = errors occurred

Authenticates the token value and returns all Stop objects that meet the provided criteria

orderHdrNumber

int

stopNumber

int

UpdateStop

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 and updates the Stop object with the specified stop number with the provided stop, when updating existing stops the operation and stop number are not used

orderHdrNumber

int

stp

Stop

operation

ListOperation

stopNumber

int

DeleteStop

tokenValue

string

0 = successful

100 = no records found

1000 = errors occurred

Authenticates the token value and deletes the specified Stop object then returns the deleted object if the deletion was successful

orderHdrNumber

int

stopNumber

int