You are viewing the documentation for Blueriq 17. Documentation for other versions is available in our documentation directory.
This page lists the behaviour of the Runtime when creating or parsing XML messages based on XSD schemas (SOAP and REST with schema sets).
The behaviour is broken down by:
- whether the message is being sent or being received
- whether attributes and relations are inside a sequence or a choice
- whether an element is mapped to an attribute or a relation
- whether the attribute or relation is single-valued or multi-valued
1. Sending an XML message
TBD
1.1 Sequences
TBD
1.1.1 Single-Valued Attributes
| Value | Source | minOccurs | nillable | Result |
|---|---|---|---|---|
| unknown | system | 0 | * | element not present |
| unknown | system | > 0 | * | error |
| unknown | user | 0 | false | empty element |
| unknown | user | 0 | true | nil element |
| unknown | user | 1 | false | empty element |
| unknown | user | 1 | true | nil element |
| unknown | user | > 1 | false | as many empty elements as required by minOccurs |
| unknown | user | > 1 | true | as many nil elements as required by minOccurs |
| known | * | * | * | an element containing the value |
1.1.2 Multi-Valued Attributes
| Value | Source | minOccurs | nillable | Result |
|---|---|---|---|---|
| unknown | system | 0 | * | no elements present |
| unknown | system | > 0 | * | error |
| unknown | user | 0 | false | empty element |
| unknown | user | 0 | true | nil element |
| unknown | user | > 0 | false | as many empty elements as required by minOccurs |
| unknown | user | > 0 | true | as many nil elements as required by minOccurs |
| known, count < minOccurs | * | * | false | count elements with values, padded with empty elements as required by minOccurs |
| known, count < minOccurs | * | * | true | count elements with values, padded with nil elements as required by minOccurs |
| known, minOccurs <= count <= maxOccurs | * | * | * | as many elements as there are values, each element containing the corresponding value |
| known, maxOccurs < count | * | * | * | error |
1.1.3 Single-Valued Relations
The source of relations is not used when handing unknown relations. Empty or nil tags are never created for relations, as that would lead to extra, unwanted instances on the receiving side.
| Value | minOccurs | nillable | Result |
|---|---|---|---|
| unknown | 0 | * | element not present |
| unknown | > 0 | * | error |
| known, attributes and relations do not generate sub-elements | * | false | empty element |
| known, attributes and relations do not generate sub-elements | * | true | nil element |
| known, at least one attribute or relation generates a sub-element | * | * | an element with sub-elements according to the rules on this page |
1.1.4 Multi-Valued Relations
TBD
| Value | minOccurs | nillable | Result |
|---|---|---|---|
| unknown | 0 | * | no elements present |
| unknown | > 0 | * | error |
| known, count < minOccurs | * | * | error |
| known, minOccurs <= count <= maxOccurs | * | false | count elements |
| known, minOccurs <= count <= maxOccurs | * | true | count elements. If any of the instances do not generate sub-elements, the element corresponding to that instance is nil |
| known, maxOccurs < count | * | * | error |
1.2 Choices
The behaviour of choices depends on the min/maxOccurs on the choice, the min/maxOccurs of the elements inside the choice, as well as the value and source of the attributes or relations mapped to those elements.
It is possible to choose multiple times, as required by minOccurs and restricted by maxOccurs on the choice. When choosing a second time, the same element that was chosen
1.2.1 Single-Valued Attributes
TBD
| Choice minOccurs | Element A | Element B | Result | Explanation | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
| Value | Source | minOccurs | nillable | Value | Source | minOccurs | nillable | |||
| 0 | unknown | system | * | * | unknown | system | * | * | no element is present | chosen 0 times, or chosen element A 0 times, or chosen element B 0 times |
| 0 | unknown | system | * | * | unknown | user | 0 | false | <B/> | chosen element B 1 time |
| 0 | unknown | system | * | * | unknown | user | 0 | true | <B xsi:nil="true"/> | chosen element B 1 time |
| 0 | unknown | system | * | * | unknown | user | 1 | false | <B/> | chosen element B 1 time |
| 0 | unknown | system | * | * | unknown | user | 1 | true | <B xsi:nil="true"/> | chosen element B 1 time |
| 0 | unknown | system | * | * | unknown | user | > 1 | false | <B /> <B/> | chosen as many empty B elements as required by element B minOccurs, chosen 1 time |
| 0 | unknown | system | * | * | unknown | user | > 1 | true | <B xsi:nil="true"/> <B xsi:nil="true"/> | chosen as many nil B elements as required by element B minOccurs, chosen 1 time |
| 0 | unknown | system | * | * | known | <= 1 | * | * | <B>value</B> | |
| 0 | unknown | system | * | * | known | > 1 | * | false | <B>value</B> <B/> | chosen 1 B element and padded with as many empty elements as required by minOccurs of element B, chosen 1 time |
| 0 | unknown | system | * | * | known | > 1 | * | true | <B>value</B> <B xsi:nil="true"/> | chosen 1 B element and padded with as many nil elements as required by minOccurs of element B, chosen 1 time |
| 0 | unknown | user | 0 | false | unknown | system | * | * | <A> | chosen element A 1 time |
| TBD | ||||||||||
| 0 | unknown | user | 0 | true | unknown | system | * | * | <A xsi:nil="true"/> | chosen element A 1 time |
| TBD | ||||||||||
| 0 | unknown | user | 1 | false | unknown | system | * | * | <A> | chosen element A 1 time |
| TBD | ||||||||||
| 0 | unknown | user | 1 | true | unknown | system | * | * | <A xsi:nil="true"/> | chosen element A 1 time |
| TBD | ||||||||||
| 0 | unknown | user | > 1 | false | unknown | system | * | * | <A>value</A> <A/> | chosen 1 A element and padded with as many empty elements as required by minOccurs of element A, chosen 1 time |
| TBD | ||||||||||
| 0 | unknown | user | > 1 | true | unknown | system | * | * | <A>value</A> <A xsi:nil="true"/> | chosen 1 A element and padded with as many nil elements as required by minOccurs of element A, chosen 1 time |
| TBD | ||||||||||
1.2.2 Multi-Valued Attributes
TBD
1.2.3 Single-Valued Relations
TBD
1.2.4 Multi-Valued Relations
TBD
2. Receiving an XML message
TBD
2.1 Sequences
TBD
2.1.1 Single-Valued Attributes
TBD
2.1.2 Multi-Valued Attributes
TBD
2.1.3 Single-Valued Relations
TBD
2.1.4 Multi-Valued Relations
TBD
2.2 Choices
TBD
2.2.1 Single-Valued Attributes
TBD
2.2.2 Multi-Valued Attributes
TBD
2.2.3 Single-Valued Relations
TBD
2.2.4 Multi-Valued Relations
TBD
Overview
Content Tools