Method: getEntitlementsQuery

Description

The getEntitlementsQuery operation returns the entitlements that match specified criteria. The response data is sorted by the most recent line item.

Tip: For more optimal memory usage, consider using getActivatableItemsQuery instead of getEntitlementsQuery to retrieve policy information for a particular line item. getActivatableItemsQuery loads only the information for the specified activation while getEntitlementsQuery loads information for the all the activations for a given EntitlementID. See getActivatableItemsQuery.

Parameters

Name	Type	Direction	Description
msgparameters	searchEntitlementRequestType	Input

Returns

A searchEntitlementResponse element having the structure defined by the following table.

Name	Type	Description
statusInfo	StatusInfoType	Element  Data Type  Description  status StatusType Returns one of the following: SUCCESS—All items in the request were processed. PARTIAL_FAILURE—Some, but not all items in the request were processed. The getCount and getQuery operations never return PARTIAL_FAILURE. FAILURE—None of the items in the request were processed. reason string Gives reason for partial failure or failure.
entitlement	entitlementDataType	See entitlementDataType.