Search Entitlements
Returns a list of Entitlements for the provided query parameters. Eid and createdBy are automatically included in the response body.
| Method Type | URI |
|---|---|
| GET |
v90/ws/entitlement.ws &pageIndex={pageIndex} &emailId={emailId} |
Example URL: http://hostname:8080/ems/v90/ws/entitlement.ws?entStatus= DRAFT&refId1=C223&refId2=CRM123&customerId=22&cstmrname= Microsys&pageIndex=5&pageSize=10&emailId=abd@example.com&vendorId=2
URI Parameters
| Parameter | Description | Type |
|---|---|---|
| entStatus | (Optional) Current status of the Entitlement. | String |
| refId1 | (Optional) Reference ID 1. Identifier of the Entitlement in another system like CRM/ERP. | String |
| refId2 | (Optional) Reference ID 2. Identifier of the Entitlement in another system like CRM/ERP. | String |
| customerId | (Optional) Identifier of the Customer in the database. | Integer |
| cstmrname | (Optional) The Customer name. | String |
| pageIndex | (Optional) The starting page number. | Integer (>0) |
| pageSize | (Optional) The number of customers retrieved by one request. | Integer (>0) |
| emailId | (Optional) Email of the customer. | String |
| vendorId | (Optional) If provided, the Entitlements that are associated with the given vendor are returned. | Integer (>0) |
| enforcementId | (Optional) Identifier of the Enforcement in the database. | Integer |
| keyId | (Optional) HASP ID or Container ID. | String |
NOTE
>You can search for contact details by providing an e-mail address as an input to the web service. Ensure that special characters in the e-mail address are sent without encoding. For example, if the e-mail address contains a '+' sign, ensure that the '+' is not replaced with '%2B'.
> By default, a GET call returns a maximum of 200 entries per page. You can change this by modifying the pageIndex and pageSize values. (To change the default maximum number of returned entries for all GET calls for Products, Entitlements, and Customers, modify the Max Records per Page (Web Services) value in the Sentinel LDK-EMS Administration Console. For details, see the Sentinel LDK–EMS Configuration Guide.)
Sample Response
HTTP Status Code: 200
Success
Response Header:
X-Total-Count: The total number of entries. You can use X-Total-Count to calculate the total number of pages by dividing X-Total-Count by pageSize (X-Total-Count÷pageSize=number of pages). For example, suppose your application returns an X-Total-Count of 17 and the pageSize is 15. 17÷15=1.333 or 2 pages in total because each page includes a maximum of 15 entries. Similarly, suppose your application returns an X-Total-Count of 1103 and the pageSize is 15. 1103÷15=73.533 or 74 pages in total.
Response Body:
<listResponse type="entitlement" count="2">
<instance id="3" eid=”8a421811-5b40-4704-92a8-2fe572671614” createdBy="admin" contact="sdash@example.com" customer="" state="DRAFT" createDate="2011-06-07 11:35:20.333" commitDate="null" />
<instance id="2" eid=”7a623911-3c40-6528-36a5-4gb354189648” createdBy="admin" contact="ssingh1@example.com" customer="" state="DRAFT" createDate="2011-06-06 16:12:57.31" commitDate="null" />
</listResponse>
NOTE The order of the search result is decided on the basis of EntId which acts as a unique identifier for each entitlement in the database.
Failure
Response Body:
<listResponse type="entitlement" count="0"/>