Enumerated Field Behavior For REST Web Services

This section explains the behavior of Enumerated Fields when used with web services (REST Add/Update/Delete/Search actions on records).

Note: All values sent in the XML are Item Values and not Display Labels.

On an Add

Field present in xml	Blank value	sort flag	default flag	xml field value	result
N	N/A	N/A	N/A	N/A	No change to db value
Y	Y	Y/N	N	N	Db value is blank
Y	Y	Y/N	Y	N	Db value will be the first value in the list/sorted list
Y	N	N/A	N/A	Y	First validation to make sure the value is a part of the list values

On an Update

Field present in xml	Blank value	sort flag	default flag	xml field value	result
N	N/A	N/A	N/A	N/A	No change to db value
Y	Y	Y/N	N	N	Db value is blank
Y	Y	Y/N	Y	N	Db value will be the first value in the list/sorted list
Y	N	N/A	N/A	Y	First validation to make sure the value is a part of the list values

Dependent Field Behavior

The Dependent Field should always be accompanied with its corresponding "parent" field in the XML for proper behavior.

Parent Field present in xml	Child Field present in xml	Parent Blank value	Child Blank value	Parent sort flag	Child sort flag	Parent default flag	Child default flag	Parent xml field value	Child xml field value	Parent result	Child result
N	N	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	No Change	No Change
Y	Y	Y	Y	Y/N	Y/N	N	N	N	N	Db value is blank	Db value is blank
Y	Y	Y	Y	Y/N	Y/N	Y	N	N	N	Db value will be the first value in the list/sorted list	Db value blank
Y	Y	Y		Y/N	Y/N	Y	Y	N	N	Db value will be the first value in the list/sorted list	Db value will be the first value in the list/sorted list corresponding to parent value
Y	Y	N	Y	N/A	Y/N	N/A	N	Y	N	First validation to make sure the value is a part of the list values	Db value blank
Y	Y	N	Y	N/A	Y/N	N/A	Y	Y	N	First validation to make sure the value is a part of the list values	Db value will be the first value in the list/sorted list corresponding to parent value
Y	Y	N	N	N/A	N/A	N/A	N/A	Y	Y	First validation to make sure the value is a part of the list values	First validation to make sure the value is a part of the list values corresponding to parent value