You are here: Usage Information > retrieveUsageLog

Retrieve Usage Log

Description

Retrieves the usage log details for a given product of an entitlement. The entitlement must be deployed on Sentinel Cloud Connect.

You can view usage of an entitlement only if it has been aggregated by Data Engine.

Default Protocol Method Type URI

HTTPS

GET

retrieveUsageLog.xml

Query Parameters

Parameter Description Valid Values Optional

entId

Identifier of the entitlement.

Note: The entId is the handle returned by the createEntitlement.xml web service. You can use the searchEntitlements.xml web service to retrieve entId for an entitlement.

Integer

No

productName Name of the product.

String

No
productVersion Version of the product. String No

startDate

Start date from when the usage log is to be obtained.

The startDate should be earlier than or same as the enddate.

String (yyyy-mm-dd)

No

endDate

End date till when the usage log is to be obtained.

String (yyyy-mm-dd)

No

pageIndex Index of the currently displayed page. Integer (>0) Default Value: 1 Yes
pageSize

Number of records to be displayed on a page.

Its default value can be configured from EMS Admin Console by using the Max Records Per Response (Web Services) property.

Integer (>0) Yes

Sample Code

import java.io.IOException;
import java.net.URLDecoder;

//..............................
//..............................
//..............................
import org.apache.http.params.HttpParams;
public class EMSSample {
	private static DefaultHttpClient httpclient = new DefaultHttpClient();
	private static Principal principal = null;
	private static StringBuffer query;
	//..............................
	//..............................
	//..............................
	public static String retrieveUsageLog.xml()throws Exception  {
		if(!verifyLogin()){
			return "login failed";
		}
		HttpContext context = new BasicHttpContext();
		context.setAttribute(ClientContext.USER_TOKEN, principal);
		HttpGet get = new HttpGet("https://localhost:8443/ems/3.6/retrieveUsageLog.xml");
		query = new StringBuffer();
		setParameter("startDate", "");
		setParameter("entId", "");
		setParameter("pageSize", "");
		setParameter("endDate", "");
		setParameter("productVersion", "");
		setParameter("productName", "");
		setParameter("pageIndex", "");
		get.setURI(new URI(URLDecoder.decode(get.getURI() + query.toString(),"UTF-8")));
		HttpResponse response = httpclient.execute(get, context);
		HttpEntity entity = response.getEntity();
		byte[] b = null;
		if (entity != null) {
			long l = entity.getContentLength();
			b = new byte[(int) l];
			entity.getContent().read(b);
			entity.consumeContent();
		}
		return new String(b);
	}
	static void setParameter(String key, String value) {
		if (query.toString().equals("")) {
			query.append("?" + key + "=" + value + "&");
		} else {
			query.append(key + "=" + value + "&");
		}
	}
}

Sample Response

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<emsResponse>
    <stat>ok
    </stat>
    <total>1</total>
    <usageRecords>
        <usageRecord>
            <featureName>addition</featureName>
            <userID>pre</userID>
            <startDate>Fri Jan 01 00:00:00 IST 2010</startDate>
            <endDate>Sun Jan 01 23:59:59 IST 2012</endDate>
            <totalConsumption>6</totalConsumption>
            <usageType>CountBased</usageType>
            <recordCount>6</recordCount>
        </usageRecord>
    </usageRecords>
</emsResponse>
See Also:

Output Format for Failure

Error Codes

Error Code Description

101

You are not authorized to use this service.

107

An internal error occurred! Please report the error to System administrator.

118

{field} should be of data type integer. [Note: This error code is applicable for the fields - featureId, License modelId, entId, ftrId, customerId, lmId, templateType, lineItemId, CustomerId, stationCount, status, and granularity.]

122

{field} is a required field and should have a not null value. [Note: This error code is applicable for the fields - Eid, namespaceName, featureName, startDate, endDate, userIds, featureId, productName, productVersion, detailsLM, lmId, templateType, customAttribute, lineItemId, customerRefId, granularity, loginId, oldPassword, and newPassword.]

123

endDate should be of dataType Date in the format yyyy-mm-dd startDate should be of dataType Date in the format yyyy-mm-dd.

128

You should log on first.

132 The URL address does not exist.
302

No product exists for given Name and Version.

617

Start date cannot be greater than end date.

621

Entitlement does not exist. Retry with a correct ID.

658

Entitlement is not in complete state, please contact administrator.

1008

Unable to retrieve Usage Data.

1028

Entitlement is not marked complete.

1081 Invalid Web service version provided
1084 No Web service version provided
1088 The EMS system is running on HTTPS. Please provide the correct Web service URL.
1102 Maximum pageIndex allowed for specified size is 1.