NonStop SOAP User's Manual

NonStop SOAP Features and Functions
NonStop SOAP User’s Manual—520501-012
4-45
Enhanced DDL Comment Tag @SOAP_OPTIONAL
Enhanced DDL Comment Tag
@SOAP_OPTIONAL
NonStop SOAP currently supports flagging a field as optional using the SOAP DDL
comment tag @SOAP_OPTIONAL. In releases prior to NonStop SOAP 3.0 if a group
field is tagged as optional then it applies only to that particular field and does not
propagate to its children (that is, the group field can be present only when all of its
children are present in the request/response XML message).
When using this tag the entire hierarchy of a group field is treated as optional (that is, a
group field can be present when only a subset of its fields are present). For example:
In the DDL definition, the HOSPITAL group field is tagged as optional (associated
children are also treated as optional). This is indicated by the value “0” in the
minOccurs attribute in the XML schema (shown in Example 4-32 on page 4-46) that
will be created by the NonStop SOAP Admin tool.
Note. This section applies only when the value of the SOAP_MAP_DEF value in the NonStop
SOAP configuration file is set to “strict”.
Example 4-31. DDL Definition
02 PATIENT-DATA.
03 ID PIC 9(5).
03 AGE PIC 9(3).
* @SOAP_OPTIONAL
03 HOSPITAL.
04 HOSP-NAME PIC X(30).
04 ADDRESS.
05 STREET PIC X(50).
05 CITY PIC X(25).
05 STATE PIC X(2).
05 ZIP PIC 9(5).
04 COUNTY.
05 CODE PIC 9(6).
05 Details.
06 COUNTY-NAME PIC X(15).
06 STATUS PIC X.
05 DESCRIPTION PIC X(100).