Using the Atom Output Format

Programmer : Mashup Programmer : Using the Mashup API : Using the Atom Output Format

namespace

This section describes the MashupFeed response elements. Collectively these formats may be referred to as MashupFeed 1.0 or simply MashupFeed. The MashupFeed Schema makes use of the OpenSearch v1.1 extension to the Atom format.

The following elements are described below:

namespace

The XML Namespace URI for the XML data formats described in this specification is:

http://schemas.exalead.com/access/1.0

Note that this namespace is subject to change in the MashupFeed 1.1 version to:

http://schemas.exalead.com/mashupfeed/1.1

All the examples below will assume that the namespace is used as the "exa" prefix.

link element

In the MashupFeed Schema, nested data feeds described with the <link> element with an "application/access+xml" type may be embedded right into the <link> element content.

entry element

In the MashupFeed schema, an entry has the following properties:

• one id which is optional (required by the standard specification)

• a title which is optional (required by the standard specification)

• many exa:meta which are optional

<entry>
<id>MDA1QTAwMDAwMDBRakRwSUFL</id>
<link rel="self" type="application/access+xml" href="http://localhost:9510/access/feeds/search/
cT0lMjNhbGw/bi/MDA1QTAwMDAwMDBRakRwSUFL"/>
<exa:meta name="id" displayName="id">005A0000000QjDpIAK</exa:meta>
<exa:meta name="username" displayName="username">doe@mycompany.com</exa:meta>
<exa:meta name="email" displayName="email">john.doer@mycompany.com</exa:meta>
<exa:meta name="name" displayName="name">John Doe</exa:meta>
</entry>

meta element

The MashupFeed meta element describes a single information element as represented in the EXALEAD index. Its location is Standard <entry> element. The meta element syntax is defined by:

• a required name attribute describing the meta name (string)

• a value in the content part of the tag (string, may be empty)

• an optional displayName attribute for internationalized / nicely formatted names

<exa:meta name="firstname">John</exa:meta>
<exa:meta name="lastname" displayName="family name">Doe</exa:meta>

feed element

The feed element may contain many facet elements that describe the different axes available for faceted search. Its location is Standard <feed> element.

facet element

The facet element describes the root of a faceted search axe and can contain several category elements.

Its location is Standard <facets> element.The facet element syntax is defined by:

• a required name attribute for the facet full name (string)

• a required description attribute for the facet display name (string)

• many category elements which are optional

<exa:facet name="Top/user/name" description="user name">
<exa:category path="Top/user/name/john doe" description="John Doe" count="1" state="DISPLAYED"/>
</exa:facet>

category element

The category element is a leaf of the facet tree. It may contain many category elements that are sub categories of the current category.

Its location is Standard <facet> element. The category element syntax is defined by:

• a required path attribute: category full path in the facet tree (string)

• a required description attribute: category display name (string)

• a required count attribute: number of hits of this category for the given query (long)

• a required state attribute: state of the category (enum: DISPLAYED|EXCLUDED|REFINED)

• optionally many category sub-elements

<exa:category path="Top/case/type/electrical" description="Electrical" count="9" state="DISPLAYED"/>