messagesResult

Namespace: http://eurotech.com/edc/2.0
XML Schema: edc.xsd

MessagesResult is a container for a list of Messages returned by a list or search messages call. It contains the list of requested Messages and a flag signaling whether the limit for the maximum number of returned entities has been reached.
If limitedExceeded is set,the client is requested to paginate through the result by moving the offset forward and issue a new request to get more data.

Example to get all messages:

// First get the total count of messages
String apiPath = "messages/count.xml";
WebResource apisWeb = client.resource(API_URL).path(apiPath);
CountResult countResult = apisWeb.get(CountResult.class);

// Then paginate to get all messages
long MSG_COUNT = countResult.getCount();
apiPath = "messages.xml";
apisWeb = client.resource(API_URL).path(apiPath);

for (int offset = 0; offset < MSG_COUNT; offset += limit) {
// set limit and offset as queryParam
// if the "limit" queryParam is not initialized, limit default value = 50
// if the "offset" queryParam is not initialized, offset default value = 0
apisWeb = apisWeb.queryParam("limit", "" + limit);
if (offset > 0)
apisWeb = apisWeb.queryParam("offset", "" + offset);

MessagesResult result = apisWeb.get(MessagesResult.class);
}

// To get all messages of a given topic
apiPath = "messages/searchByTopic.xml";
apisWeb = client.resource(API_URL).path(apiPath);
apisWeb = apisWeb.queryParam("topic", topic);

MessagesResult result;
int offset = 0;
do {
apisWeb = apisWeb.queryParam("limit", "" + limit);
if (offset > 0)
apisWeb = apisWeb.queryParam("offset", "" + offset);
result = apisWeb.get(MessagesResult.class);
offset += limit;
} while (result.isLimitExceeded()):

XML

Elements

name (type) min/max
occurs
description
limitExceeded (boolean) 1/1
message (edcMessage) 0/unbounded

JSON

property type description
limitExceeded limitExceeded (boolean)
message array of message (edcMessage)