Get Entitlement Details (XML) by entId
Returns a list of line items, with Products, Features, and License Model, for the provided entId. Eid and createdBy are automatically included in the response body.
| Method Type | URI |
|---|---|
| GET | v90/ws/entitlement/{entId}.ws |
URI Parameters
| Parameter | Description | Type |
|---|---|---|
| entId |
The unique identifier for the Entitlement in the database. NOTE This is different from the Entitlement ID string. Examples: >entId: 10 (integer) >Entitlement ID (or EID): gd5f6vfg-y57f-he55-3r5d7w9g7tx3 (string) |
Integer (>0) |
Sample Request
Not applicable.
Sample Response
Success
HTTP Status Code: 200
NOTE If your entitlement contains memory segments with blank spaces in addition to the content, then the XML returned by the Get Entitlement web service will replace the blank spaces with all zeros. To re-use this XML, replace the content (including the zeros) with its hexadecimal equivalent so that memory data is correctly updated in Sentinel LDK-EMS and can be referred to in both the web service and GUI without any issues.
Response Body:
<entitlement>
<eid>eee560bf-d46f-4659-ab3a-f0bec8a9969a</eid>
<createdBy>admin</createdBy>
<startDate>2016-10-17</startDate>.
<startDate>2016-10-17</startDate>.
<endDate>2500-12-31</endDate>
<createDate>2016-10-17</createDate>
<commitDate>2016-10-17</commitDate>
<enabled>true</enabled>
<entState>COMPLETED</entState>
<isTest>false</isTest>
<customerId>1</customerId>
<customerEmail>manishgarg@gmail.com</customerEmail>
<policy>
<registrationRequired>NOT_REQUIRED</registrationRequired>
</policy>
<refId1>
</refId1>
<refId2>
</refId2>
<description>
</description>
<entitlementItem>
<startDate>2016-10-17</startDate>
<endDate>2500-12-31</endDate>
<numProductKeys>1</numProductKeys>
<numActivationPerProductKey>1</numActivationPerProductKey>
<priority>D</priority>
<vendorId>1</vendorId>
<enforcementId>2</enforcementId>
<identityCount>-1</identityCount>
<lineItemType>Product_Key</lineItemType>
<deploymentType>Cloud</deploymentType>
<itemProduct>
<productId>1</productId>
<product>
<productName>CP1</productName>
<baseProductId>0</baseProductId>
<productIdentifier>2</productIdentifier>
<lifeCycleStage>COMMIT</lifeCycleStage>
<enforcementProductType>BASE</enforcementProductType>
<enforcementProtectionType>HL_or_SL_AdminMode_or_SL_UserMode</enforcementProtectionType>
<rehost>LEAVE_AS_IS</rehost>
<productDescription>
</productDescription>
<refId1>
</refId1>
<refId2>
</refId2>
<enabled>true</enabled>
<deployed>true</deployed>
<productFeatureRef>
<featureId>1</featureId>
<actionName>NONE</actionName>
<productFeatureLicenseModel>
<actionName>NONE</actionName>
<licenseModel>
<licenseModelId>8</licenseModelId>
<licenseModelName>Postpaid</licenseModelName>
<licenseType>0</licenseType>
<lmAttribute>
<attribute>
<attributeId>31</attributeId>
<attributeName>DEPLOYMENT_TYPE</attributeName>
<attributeType>7</attributeType>
<attributeValueChoice>
<valueOption>On-Premise</valueOption>
</attributeValueChoice>
<attributeDefaultValue>
</attributeDefaultValue>
<displayOrder>4</displayOrder>
<attributeLevel>1</attributeLevel>
<associatedLockCriteria>
</associatedLockCriteria>
<associatedLockCriteriaValue>
</associatedLockCriteriaValue>
<endUserPermission>0</endUserPermission>
<parameterGroupName>Deployment Attibute</parameterGroupName>
<parameterSubGroupName>Deployment Attibute</parameterSubGroupName>
<isvPermission>WRITE</isvPermission>
<nullable>false</nullable>
<saotAllowed>true</saotAllowed>
</attribute>
<attributeValue>03</attributeValue>
<saot>false</saot>
<actionName>NONE</actionName>
</lmAttribute>
<lmAttribute>
<attribute>
<attributeId>32</attributeId>
<attributeName>KEEP_ALIVE_TIME</attributeName>
<attributeType>3</attributeType>
<attributeDefaultValue>
</attributeDefaultValue>
<displayOrder>5</displayOrder>
<attributeLevel>1</attributeLevel>
<associatedLockCriteria>
</associatedLockCriteria>
<associatedLockCriteriaValue>
</associatedLockCriteriaValue>
<endUserPermission>0</endUserPermission>
<parameterGroupName>Deployment Attibute</parameterGroupName>
<parameterSubGroupName>Deployment Attibute</parameterSubGroupName>
<isvPermission>WRITE</isvPermission>
<nullable>false</nullable>
<saotAllowed>true</saotAllowed>
</attribute>
<attributeValue>30</attributeValue>
<saot>false</saot>
<actionName>NONE</actionName>
</lmAttribute>
<lmAttribute>
<attribute>
<attributeId>22</attributeId>
<attributeName>USAGE_TYPE</attributeName>
<attributeType>7</attributeType>
<attributeValueChoice>
<valueOption>Count Based</valueOption>
<valueOption>Time Based</valueOption>
</attributeValueChoice>
<attributeDefaultValue>
</attributeDefaultValue>
<displayOrder>4</displayOrder>
<attributeLevel>1</attributeLevel>
<associatedLockCriteria>
</associatedLockCriteria>
<associatedLockCriteriaValue>
</associatedLockCriteriaValue>
<endUserPermission>0</endUserPermission>
<parameterGroupName>Usage Type</parameterGroupName>
<parameterSubGroupName>Usage Type</parameterSubGroupName>
<isvPermission>WRITE</isvPermission>
<nullable>false</nullable>
<saotAllowed>true</saotAllowed>
</attribute>
<attributeValue>2</attributeValue>
<saot>true</saot>
<actionName>NONE</actionName>
</lmAttribute>
<lmAttribute>
<attribute>
<attributeId>25</attributeId>
<attributeName>LICENSE_TYPE</attributeName>
<attributeType>1</attributeType>
<attributeDefaultValue>
</attributeDefaultValue>
<displayOrder>1</displayOrder>
<attributeLevel>1</attributeLevel>
<associatedLockCriteria>
</associatedLockCriteria>
<associatedLockCriteriaValue>
</associatedLockCriteriaValue>
<endUserPermission>0</endUserPermission>
<parameterGroupName>UserID</parameterGroupName>
<parameterSubGroupName>UserID</parameterSubGroupName>
<isvPermission>WRITE</isvPermission>
<nullable>false</nullable>
<saotAllowed>true</saotAllowed>
</attribute>
<attributeValue>2</attributeValue>
<saot>false</saot>
<actionName>NONE</actionName>
</lmAttribute>
<lmAttribute>
<attribute>
<attributeId>21</attributeId>
<attributeName>END_DATE</attributeName>
<attributeType>2</attributeType>
<attributeDefaultValue>
</attributeDefaultValue>
<displayOrder>2</displayOrder>
<attributeLevel>1</attributeLevel>
<associatedLockCriteria>
</associatedLockCriteria>
<associatedLockCriteriaValue>
</associatedLockCriteriaValue>
<endUserPermission>0</endUserPermission>
<parameterGroupName>Time</parameterGroupName>
<parameterSubGroupName>License Validity</parameterSubGroupName>
<isvPermission>WRITE</isvPermission>
<nullable>false</nullable>
<saotAllowed>true</saotAllowed>
</attribute>
<attributeValue>2500-12-31 00:00</attributeValue>
<saot>true</saot>
<actionName>NONE</actionName>
</lmAttribute>
<lmAttribute>
<attribute>
<attributeId>20</attributeId>
<attributeName>START_DATE</attributeName>
<attributeType>2</attributeType>
<attributeDefaultValue>
</attributeDefaultValue>
<displayOrder>1</displayOrder>
<attributeLevel>1</attributeLevel>
<associatedLockCriteria>
</associatedLockCriteria>
<associatedLockCriteriaValue>
</associatedLockCriteriaValue>
<endUserPermission>0</endUserPermission>
<parameterGroupName>Time</parameterGroupName>
<parameterSubGroupName>License Validity</parameterSubGroupName>
<isvPermission>WRITE</isvPermission>
<nullable>false</nullable>
<saotAllowed>true</saotAllowed>
</attribute>
<attributeValue>2016-10-03 00:00</attributeValue>
<saot>true</saot>
<actionName>NONE</actionName>
</lmAttribute>
<lmAttribute>
<attribute>
<attributeId>33</attributeId>
<attributeName>REFRESH_PERIOD</attributeName>
<attributeType>3</attributeType>
<attributeDefaultValue>
</attributeDefaultValue>
<displayOrder>5</displayOrder>
<attributeLevel>1</attributeLevel>
<associatedLockCriteria>
</associatedLockCriteria>
<associatedLockCriteriaValue>
</associatedLockCriteriaValue>
<endUserPermission>0</endUserPermission>
<parameterGroupName>Deployment Attibute</parameterGroupName>
<parameterSubGroupName>Deployment Attibute</parameterSubGroupName>
<isvPermission>WRITE</isvPermission>
<nullable>false</nullable>
<saotAllowed>true</saotAllowed>
</attribute>
<attributeValue>80</attributeValue>
<saot>false</saot>
<actionName>NONE</actionName>
</lmAttribute>
<lmAttribute>
<attribute>
<attributeId>30</attributeId>
<attributeName>DISCONNECTED_TIME</attributeName>
<attributeType>3</attributeType>
<attributeDefaultValue>
</attributeDefaultValue>
<displayOrder>3</displayOrder>
<attributeLevel>1</attributeLevel>
<associatedLockCriteria>
</associatedLockCriteria>
<associatedLockCriteriaValue>
</associatedLockCriteriaValue>
<endUserPermission>0</endUserPermission>
<parameterGroupName>Deployment Attibute</parameterGroupName>
<parameterSubGroupName>Deployment Attibute</parameterSubGroupName>
<isvPermission>WRITE</isvPermission>
<nullable>false</nullable>
<saotAllowed>true</saotAllowed>
</attribute>
<attributeValue>1</attributeValue>
<saot>false</saot>
<actionName>NONE</actionName>
</lmAttribute>
<lmAttribute>
<attribute>
<attributeId>34</attributeId>
<attributeName>VENDOR_ATTRIBUTE</attributeName>
<attributeType>1</attributeType>
<attributeDefaultValue>
</attributeDefaultValue>
<displayOrder>5</displayOrder>
<attributeLevel>1</attributeLevel>
<associatedLockCriteria>
</associatedLockCriteria>
<associatedLockCriteriaValue>
</associatedLockCriteriaValue>
<endUserPermission>0</endUserPermission>
<parameterGroupName>Vendor Attribute</parameterGroupName>
<parameterSubGroupName>Vendor Attribute</parameterSubGroupName>
<isvPermission>WRITE</isvPermission>
<nullable>false</nullable>
<saotAllowed>true</saotAllowed>
</attribute>
<attributeValue>
</attributeValue>
<saot>true</saot>
<actionName>NONE</actionName>
</lmAttribute>
</licenseModel>
</productFeatureLicenseModel>
<lmStatus>DEFINED</lmStatus>
<excludable>true</excludable>
<featureName>F1</featureName>
<featureIdentifier>1</featureIdentifier>
<featureDescription>
</featureDescription>
</productFeatureRef>
</product>
<productStatus>ENABLE</productStatus>
</itemProduct>
<productKeyId>a7c4d8e7-6387-4fd2-8544-6517abe40bc4</productKeyId>
<pcId>3f7d30bb-3080-41ad-a857-97bc9eefebf6</pcId>
</entitlementItem>
</entitlement>
Count_Criteria
>0 - Station
>1 - Login
>2 - Process
Counting_Type
>1 - Per login
>2 - Per Identity
>3 - Per Identity per station
Failure
HTTP Status Code: 404
Response Body: Entitlement does not exist. Try again with a correct entId.