TBXDS/3 - GroupedBy

The GroupedBy Element

Description

Indicates to which collection the current issue belongs, and to which filter. When applicable, the order attribute is set (only if filter is also present).

Attributes

Attribute name	Data type	Description
collection	string(255)
filter Optional	literal
order Optional	integer

Number of occurences

Once

Occurs within

<Issue>

Can contain

None (element is closed).

Notes

Available from version 2.1; can be activated for earlier versions through <Parameter>.

Filter information is only returned when it is requested. So, if you request a collection without a filter, no filter specification is added. To receive the filter specification, simply add a second request with the same collection, but now with the desired filter. The filter information will now be added.

Example

<GroupedBy collection="Euronext.Amsterdam.Shares.AEX" filter="top-5" order="3"/>

This node indicates that for the most traded shares of the AEX, this share takes position 3. The filter and order attributes are only returned when the <Quote> (collection) specified a filter, and order is only set when the filter supplies such information.

By default, if issues have a specific main collection to which they belong, a <GroupedBy> node is created. Next, for all issues requested by a collection, a new <GroupedBy> node is created if the relevant node was not already present. When a filter is applied, a unique node is created. Hence, for the request

<Quote collection="Euronext.Amsterdam.Trusts.Dutch" filter="top-5"/>

at least the following node is added:

<GroupedBy collection="Euronext.Amsterdam.Trusts.Dutch" filter="top-5" order="x"/>

But if the issue was also marked explicitly in the as belonging the same collection, the node:

<GroupedBy collection="Euronext.Amsterdam.Trusts.Dutch"/>

is not added, since the reference is already present with the filtered <GroupedBy> node.

However, when an issue is part of two separate filters for the same collection, two <GroupedBy> nodes are added:

<GroupedBy collection="Euronext.Amsterdam.Shares.AEX" filter="top-25" order="x"/>
<GroupedBy collection="Euronext.Amsterdam.Shares.AEX" filter="risers-5" order="x"/>

Note though, that for such default grouping, the user account must be extended. Contact your vwd group Netherlands contact person for details.