Description

The Aggregator interface provides a way of talking to the aggregators through the ECKCore.


Invocation

The url for the interface takes the form /<aggregator>/<action>/<urlParameter1>/<urlParameter2>?parameters Where:

URL Part Description
aggregator The code for the aggregator that you want to retrieve the statistics from (eg. DarkAggregator, CultureGridTest, CultureGridLive, Europeana, SetManager, ...)
action The action to be performed against the aggregator
urlParameter1 The purpose of this parameter varies depending on the action being performed, see the action for more details
urlParameter2 The purpose of this parameter varies depending on the action being performed, see the action for more details

The possible actions are:

Note: Not all aggregators support all actions, when the aggregator does not support the action or support has not been added for an aggregator the http status 400 will be returned with an explanatory message


Parameters

There is one general parameter that the ECKCore intercepts and takes notice off and that is rawRequired, if this is set to yes then the raw data returned from the aggregator will be passed back to the caller, if it is not set or not set to yes then we will not map the data to the generic format unless xml is being returned form the server.

Response

The data for all actions is returned as json

Testing

A simple test form is available from each of the action pages