ReferenceNumberInOrder object

ReferenceNumberInOrder 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
	Name	Data Type (in C#)	Name	Data Type	Modifiable	Comments
1	DataSourceID	string			N/A	Not mapped
2	ID	int	r.ref_id	int	Insert/Update	Required for 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	IsValid	bool			N/A	Not mapped or used in service
6	OrderHeaderNumber	int			Insert/Update	Not mapped
7	ReferenceTable	string	r.ref_table	varchar(18)	Insert/Update
8	ReferenceTableKey	int	r.ref_tablekey	int	Insert/Update
9	ReferenceType	string	r.ref_type	varchar(6)	Insert/Update
10	UpdateableProperties	ReferenceNumberUpdateInfo			N/A	Not mapped
11	Value	string	r.ref_number	varchar(30)	Insert/Update

Property

Database Column

Name

Data Type (in C#)

Name

Data Type

Modifiable

Comments

1

DataSourceID

string

N/A

Not mapped

2

ID

int

r.ref_id

int

Insert/Update

Required for 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

IsValid

bool

N/A

Not mapped or used in service

6

OrderHeaderNumber

int

Insert/Update

Not mapped

7

ReferenceTable

string

r.ref_table

varchar(18)

Insert/Update

8

ReferenceTableKey

int

r.ref_tablekey

int

Insert/Update

9

ReferenceType

string

r.ref_type

varchar(6)

Insert/Update

10

UpdateableProperties

ReferenceNumberUpdateInfo

N/A

Not mapped

11

Value

string

r.ref_number

varchar(30)

Insert/Update

ReferenceNumberInOrder methods

The Return Value for all methods is ReferenceNumber.ReturnObject.

Internal

	Parameters
Method Name	Name	Data type (in C#)	ReferenceNumber.ReturnObject. ReturnCode	Description
NewReferenceNumberInOrder	orderHeaderNumber	int	0 = successful 1000 = errors occurred	Creates a new ReferenceNumberInOrder object with the specified orderheader number in memory
	referenceTable	ReferenceNumberTable
	referenceTableKey	int
NewReferenceNumbersInOrder	orderHeaderNumber	int	0 = successful 1000 = errors occurred	Creates the specified number of new ReferenceNumberInOrder objects with the specified orderheader number in memory
	referenceTable	ReferenceNumberTable
	referenceTableKey	int
	total	int
RetrieveReferenceNumbersInOrder	orderHeaderNumber	int	0 = successful 100 = no records found 1000 = errors occurred	Returns all ReferenceNumberInOrder 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 ReferenceNumberInOrder objects 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 ReferenceNumberInOrder object
	referenceTable	ReferenceNumberTable
	referenceTableKey	int
	referenceNumberID	int

Parameters

Method Name

Name

Data type (in C#)

ReferenceNumber.ReturnObject.
ReturnCode

Description

NewReferenceNumberInOrder

orderHeaderNumber

int

0 = successful

1000 = errors occurred

Creates a new ReferenceNumberInOrder object with the specified orderheader number in memory

referenceTable

ReferenceNumberTable

referenceTableKey

int

NewReferenceNumbersInOrder

orderHeaderNumber

int

0 = successful

1000 = errors occurred

Creates the specified number of new ReferenceNumberInOrder objects with the specified orderheader number in memory

referenceTable

ReferenceNumberTable

referenceTableKey

int

total

int

RetrieveReferenceNumbersInOrder

orderHeaderNumber

int

0 = successful

100 = no records found

1000 = errors occurred

Returns all ReferenceNumberInOrder 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 ReferenceNumberInOrder objects 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 ReferenceNumberInOrder object

referenceTable

ReferenceNumberTable

referenceTableKey

int

referenceNumberID

int

External

	Parameters
Method Name	Name	Data type (in C#)	ReferenceNumber.ReturnObject. ReturnCode	Description
NewReferenceNumberInOrder	tokenValue	string	0 = successful 1000 = errors occurred	Creates a new ReferenceNumberInOrder object with the specified orderheader number in memory
	orderHeaderNumber	int
	referenceTable	ReferenceNumberTable
	referenceTableKey	int
NewReferenceNumbersInOrder	tokenValue	string	0 = successful 1000 = errors occurred	Creates the specified number of new ReferenceNumberInOrder objects with the specified orderheader number in memory
	orderHeaderNumber	int
	referenceTable	ReferenceNumberTable
	referenceTableKey	int
	total	int
RetrieveReferenceNumbersInOrder	tokenValue	string	0 = successful 100 = no records found 1000 = errors occurred	Returns all ReferenceNumberInOrder objects that meet the provided criteria
	orderHeaderNumber	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	Saves the provided ReferenceNumberInOrder objects and updates the database if requested, then returns the saved objects if the save was successful
	orderHeaderNumber	int
	referenceNumbers	List<ReferenceNumber>
	updateDB	bool
DeleteReferenceNumberInOrder	tokenValue	string	0 = successful 1000 = errors occurred	Deletes the specified ReferenceNumberInOrder object
	orderHeaderNumber	int
	referenceTable	ReferenceNumberTable
	referenceTableKey	int
	referenceNumberID	int

Parameters

Method Name

Name

Data type (in C#)

ReferenceNumber.ReturnObject.
ReturnCode

Description

NewReferenceNumberInOrder

tokenValue

string

0 = successful

1000 = errors occurred

Creates a new ReferenceNumberInOrder object with the specified orderheader number in memory

orderHeaderNumber

int

referenceTable

ReferenceNumberTable

referenceTableKey

int

NewReferenceNumbersInOrder

tokenValue

string

0 = successful

1000 = errors occurred

Creates the specified number of new ReferenceNumberInOrder objects with the specified orderheader number in memory

orderHeaderNumber

int

referenceTable

ReferenceNumberTable

referenceTableKey

int

total

int

RetrieveReferenceNumbersInOrder

tokenValue

string

0 = successful

100 = no records found

1000 = errors occurred

Returns all ReferenceNumberInOrder objects that meet the provided criteria

orderHeaderNumber

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

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

orderHeaderNumber

int

referenceNumbers

List<ReferenceNumber>

updateDB

bool

DeleteReferenceNumberInOrder

tokenValue

string

0 = successful

1000 = errors occurred

Deletes the specified ReferenceNumberInOrder object

orderHeaderNumber

int

referenceTable

ReferenceNumberTable

referenceTableKey

int

referenceNumberID

int

ReferenceNumberInOrder.ReturnObject

This object does not have its own ReturnObject. Instead, it uses ReferenceNumber.ReturnObject.

ReferenceNumberInOrderUpdateInfo object

This object does not have its own UpdateInfo object. Instead, it uses ReferenceNumberUpdateInfo object.

Criteria object

This object does not have its own Criteria object. Instead, it uses the Criteria object associated with the ReferenceNumber object.