Enumerated Field Behavior For REST Web Services

Enumerated Field Behavior For REST Web Services

From LongJump Support Wiki

Enumerated Field Behavior For REST Web Services
Jump to: navigation, search

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

File:notepad.png

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

On an Add
Field present in xmlBlank valuesort flagdefault flagxml field valueresult
NN/AN/AN/AN/ANo change to db value
YYY/NNNDb value is blank
YYY/NYNDb value will be the first value in the list/sorted list
YNN/AN/AYFirst validation to make sure the value is a part of the list values
On an Update
Field present in xmlBlank valuesort flagdefault flagxml field valueresult
NN/AN/AN/AN/ANo change to db value
YYY/NNNDb value is blank
YYY/NYNDb value will be the first value in the list/sorted list
YNN/AN/AYFirst 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 xmlChild Field present in xmlParent Blank valueChild Blank valueParent sort flagChild sort flagParent default flagChild default flagParent xml field valueChild xml field valueParent resultChild result
NNN/AN/AN/AN/AN/AN/AN/AN/ANo ChangeNo Change
YYYYY/NY/NNNNNDb value is blankDb value is blank
YYYYY/NY/NYNNNDb value will be the first value in the list/sorted listDb value blank
YYYY/NY/NYYNNDb 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
YYNYN/AY/NN/ANYNFirst validation to make sure the value is a part of the list valuesDb value blank
YYNYN/AY/NN/AYYNFirst validation to make sure the value is a part of the list valuesDb value will be the first value in the list/sorted list corresponding to parent value
YYNNN/AN/AN/AN/AYYFirst validation to make sure the value is a part of the list valuesFirst validation to make sure the value is a part of the list values corresponding to parent value
Personal tools