Account.isEntitled
Web Session Object
Transaction Object
Token Object
Season Set Object
Refund Object
RatePlan Object
Product Object
Payment Provider Object
Payment Method Object
NameValuePair Object
GiftCard Object
Entitlement Object
Chargeback Object
Campaign Object
BillingPlan Object
AutoBill Object
Address Object
Activity Object
Account Object
Account.isEntitled
The isEntitled method determines whether or not an Account has an entitlement at the moment the method is called. isEntitled returns a Boolean true/false, and does not return the length of time, past or future, for which the Account is entitled. This will check account entitlements, as well as entitlements associated with the Account’s AutoBills.
Input
srd: sparse response description, a SOAP string (which must be a JSON object), in which you specify the elements you want returned.This parameter enables the calling system to constrain a method call to return only components you specify. This gives you greater control over returned content, and improves response time within the Vindicia platform by reducing the processing needed for the call.
Some fields are required, either practically or in the WSDL, and will be returned regardless of the srd. A null srd returns the complete response.
account: the Account to which this grant applies.
merchantEntitlementId: the merchant’s unique ID for this entitlement.
Output
return: an object of type Return that indicates the success or failure of the call.
entitled: true if the Account is entitled; false if the Account is not.
Returns
In addition to those listed in Standard Return Codes, this call returns:
Return Code |
Return String |
400 |
One of the following:
|
Example
// to determine if an account is entitled
$acct = new Account();
$acct->setMerchantAccountId('xyz123');
$response = $acct->isEntitled('bac');
if ($response['returnCode'] == 200) {
if ($response['data']->entitled) {
// proceed
}
}
else {
// not entitled yet
}
$entitle = new Entitlement();
$entitle->setDescription('For playing Scrabble');
$entitle->setStartTimestamp($today);
$entitle->setEndTimestamp($tomorrow);
$entitle->setMerchantEntitlementId('bac');
$acct->grantEntitlement($entitle);
$response = $acct->isEntitled('bac');
if ($response['returnCode'] == 200) {
if ($response['data']->entitled) {
// proceed
}
}
else {
print 'Should be entitled!!';
}
For Users
Learn More