TBXDS/3 - Agency

The Agency Element

Description

<News> article request filter that returns <Article>s based on their agency code. You can be more specific by adding several child elements.

Note By default, only news articles in a single language will be returned: the default language as specified in the <ResponseSettings> section (which defaults to Dutch). To receive articles in a non-default language, use one or more <Language> child nodes, or the new language attribute.

Attributes

Attribute name Data type Description

id Required

string

The identifier of the news agency from which you want data, for example:

Tijd.Belegger
Tijd.Betten		(aka Dow Jones)
Tijd.Nieuwslijn		(aka Tijd Realtime)

and, for backwards compatibility

NWL
Betten

You can also specify "*" to recieve news articles from all news agencies you have access to.

last-article-id Optional integer The identifier of the very last news article you recieved with your last request, and an indication you don't want to recieve the older articles any more. You will have recieved this id as part of the <MetaData> information. Used in combination with date-start and date-end. See also ordering.

max-count Optional integer Indicates the maximum number of articles returned through this news request. The collection of the articles can be resumed through the <LastPublishedId> mechanism and last-article-id.

date-start Optional datetime From which date you wish to recieve the news articles. Used in combination with date-end. When not specified, TBXDS assumes you want last week's news (today minus 7 days).

date-end Optional datetime Up to which date you wish to recieve the news articles. Used in combination with date-start. When not specified, TBXDS will assume that there's a week between date-end and date-start (start + 7 days).

language Required language id Indicates which languages you wish to consider for the news articles. This is a comma separated list of ISO language codes, or a "*" indicating there should not be a filter on language. In version 1.0 this was specified through <Language>.

mode Optional

literal

Indicates which type of output is requested:

default
nested
summary

content-handler Optional

literal

Indicates the component to be used to take care of special formatting. The usage of this attribute is only intended for specific purposes, and not generally supported. By default the value of the response content-type attribute is used, which is usually Normal.

Another publicly available content handler is tbxds:cdata-override which emits CDATA-nodes rather than text nodes for news article nodes, much like the "no" value for the omit-cdata parameter (see <Parameter>).

For Tijd XML news messages, the handler tbxds:flat-tijd-xml can be used, which strips any XML tags present, and uses newlines instead of <PAR> nodes.

Standard behavior for Tijd XML:

<PAR>paragraph 1</PAR>
<PAR>paragraph 2</PAR>

and for the tbxds:flat-tijd-xml override:

paragraph 1

paragraph 2

For plain-text news messages the content handler tbxds:force-tijd-xml can be used to simulate the exact oposite of the tbxds:flat-tijd-xml handler, i.e., this handler adds <PAR> and <LIT> tags to a news message. Note however, that these tags are added after an automatic inspection of the actual text, and this process can occasionally be fooled by more advanced tabular mark-up using spaces and newlines.

Note For Tijd Nieuwslijn/Betten customers it can be very useful to use either tbxds:flat-tijd-xml or tbxds:force-tijd-xml, since Tijd Nieuwslijn uses both plain text and XML tagged news articles. This way, there is no need to inspect the content-type attribute of news articles.

link-handlers Optional

literal

Indicates a comma separated list of components to be used for building the list of links for a news article. By default, only organisation, category and sector links are returned, but more link types are available.

The setting of the link-handlers attribute overrides the default setting of "default". Thus, removing any link information can be accomplished by setting link-handlers="".

If the default links are still required, but additional links are needed, you can use the alias default as part of the list of link components, i.e., link-handlers="default,exchange".

The available types are:

category		Links to categories. See <Categories>.
default		The default links (organisation, sector and category)
destination		Links to destination information. See <Destinations>.
exchange		Links to exchanges. See <Exchanges>.
organisation		Links to organisations. See <Organisations>.
sector		Links to sectors. See <Sectors>.
ftse-sector		Links to FTSE sectors. See <FtseSectors>.
Betten:kenmerk		(Obsolete) Links to Betten categories. Returns a collection named <Betten.Kenmerken>. These nodes contain the older Betten kenmerk codes, rather than the vwd group category codes. Note that with the acquisition of Betten by Dow Jones, this functionality is no longer supported.

ordering Optional

string

Indicates the ordering used for the news queries.

default		Alias for sequence.
most-recent		Items are returned based on their date and time values, sorted downward. In combination with max-count, this can be used to retrieve only the last n items, skipping any older item. This ordering can also skip articles that have been antedated.
oldest		Items are returned based on their date and time values, sorted upward. In combination with max-count, this can be used to retrieve only the first n items, skipping newer items.
sequence		Items are returned based on their id value, sorted upward. This is the default setting.
sequence-last		Items are returned based on their id value, sorted downward. In combination with max-count, this can be used to retrieve only the last n items, skipping any older item.

Note that sorting by most-recent or oldest precludes the use of last-article-id; last-article-id can be used only with sorted and sorted-last.

Number of occurences

Required (unlimited)

Occurs within

<News>

Can contain