Actions

Search Actions

Concrete Search Requests

SearchRequest Template

Search Actions are derived from the AbstractSearchRequest type, which acts as a template for all search based actions.

Representation Element

The Representation element is used to specify how the result items should be delivered.

The details attribute can be used to select presets of result representation scope and fidelity.

The Resource child element can be used to override defaults and further refine the result data.

Each action has a set of supported resource roles, some common, like item (representing the whole search result item) and image (the associated images). Some are specific to the concrete action and are called item facets. They represent additional associated data related to the search result item.

For example, if you want each item as a separate file within the ZIP Bundle, use the following:

<Representation xmlns="urn:ige:schema:xsd:datadeliverycommon-1.0.0">
   <Resource role="item" action="Bundle"/>
</Representation>

The special roles * and facet/* can be used to assign a ResourceAction to all roles or all item facet roles, respectively.

<Representation xmlns="urn:ige:schema:xsd:datadeliverycommon-1.0.0">
   <Resource role="*" action="Bundle"/>
</Representation>

ResourceAction	Description
`Link`	Reference with a URI
`Embed`	Embed into the result XML
`Bundle`	Add to the result ZIP Bundle
`DataURL`	Inline as RFC2397 data URL
`Skip`	Do not include in the result

Page Element

The Page element is used to control the paging of the result items.

Query Element

The Query element is used to describe the search criteria.

Concrete request types can extend the AbstractDefinedFieldsQuery element to provide domain specific search criteria.

Sort Element

The Sort element is used to describe the sorting criteria.

Concrete request types can extend the AbstractSortField element to provide domain specific sorting criteria.

Sort Element

Special Actions

UserQuota Action

Specification	Value
XSD Documentation	datadelivery-quota-1-0-0
XSD Schema	https://schema.ige.ch/xml/datadelivery-quota-1-0-0.xsd
Action element content	`UserQuotaRequest`
Action `type` Attribute	`"UserQuota"`

<?xml version="1.0" encoding="UTF-8"?>
<ApiRequest xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
        xsi:schemaLocation="
        urn:ige:schema:xsd:datadeliverycore-1.0.0 urn:publicid:-:IGE:XSD+DATADELIVERYCORE+1.0.0:EN
        urn:ige:schema:xsd:datadeliveryquota-1.0.0 urn:publicid:-:IGE:XSD+DATADELIVERYQUOTA+1.0.0:EN"
        xmlns="urn:ige:schema:xsd:datadeliverycore-1.0.0">
 
        <Action type="UserQuota">
           <UserQuotaRequest xmlns="urn:ige:schema:xsd:datadeliveryquota-1.0.0"/>
        </Action>
</ApiRequest>

Echo Action

Specification	Value
Action element content	any non `urn:ige:schema:xsd:datadeliverycore-1.0.0` element
Action `type` Attribute	`"Echo"`

<?xml version="1.0" encoding="UTF-8"?>
<ApiRequest xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
        xsi:schemaLocation="
        urn:ige:schema:xsd:datadeliverycore-1.0.0 urn:publicid:-:IGE:XSD+DATADELIVERYCORE+1.0.0:EN"
        xmlns="urn:ige:schema:xsd:datadeliverycore-1.0.0">

        <Action type="Echo">
           <div xmlns="http://www.w3.org/1999/xhtml">
            <span>Hello IPI &amp; friends! &lt;3</span>
            <span>äëü éèê</span>
           </div>
        </Action>
</ApiRequest>

No Action

<?xml version="1.0" encoding="UTF-8"?>
<ApiRequest xmlns="urn:ige:schema:xsd:datadeliverycore-1.0.0"/>