You are here: State and Status Information > retrieveLicenseState

Retrieve License State

Description

Retrieves the license state for the given line item and ftrId. The license state can be:

The entitlement should be in the Complete lifecycle stage.

Default Protocol Method Type URI
HTTPS GET retrieveLicenseState.xml

Query Parameters

Parameter Description Valid Values Optional
lineItemId Specify the line item ID. Integer No
ftrId

Specify the unique record ID of feature (as stored in EMS database) corresponding to the specified line item.

Note: The ftrId is the handle returned by the addFeature.xml web service. You can retrieve ftrId by using the featureList.xml web service. In the response of this Web service, the value of tag 'id' under the 'feature' tag denotes ftrId.

Integer No

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 retrieveLicenseState.xml()throws Exception {
                if(!verifyLogin()){
                        return "login failed";
                }
                HttpContext context = new BasicHttpContext();
                context.setAttribute(ClientContext.USER_TOKEN, principal);
                HttpGet get = new HttpGet("https://localhost:8080/ems/3.6/retrieveLicenseState.xml");
                query = new StringBuffer();
                setParameter("ftrId", "");
                setParameter("lineItemId", "");
                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>
    <licenseState>1</licenseState>
</emsResponse>
See Also:

Output Format for Failure

Error Codes

Error Code Description
100 Invalid request parameter.
102 Invalid data entered.
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.]
128 You should log on first.
132 The URL address does not exist.
309 Unable to find feature.
618 Could not find the entitlement line item.
680 The feature does not exist in the given product.
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.