Entitlement

Methods

fetchByEntitlementIdAndAccount http://soap.vindicia.com/Entitlement#fetchByEntitlementIdAndAccount

Input (fetchByEntitlementIdAndAccount_in)

Name	Type
auth	Authentication
entitlementId	xsd:string
account	Account

Output (fetchByEntitlementIdAndAccount_out)

Name	Type
return	Return
entitlement	Entitlement

Loads an entitlement by its unique merchant id and the Account that owns it.

Input Fields

auth: Credentials required to authenticate this request
entitlementId: The unique id of the entitlement
account: The account that owns the entitlement

Output Fields

return: Basic results of this request (success, failure, error, etc.)
entitlement: Entitlement for a given Account

fetchByAccount http://soap.vindicia.com/Entitlement#fetchByAccount

Input (fetchByAccount_in)

Name	Type
auth	Authentication
account	Account
showAll	xsd:boolean

Output (fetchByAccount_out)

Name	Type
return	Return
entitlements	ArrayOfEntitlements

Loads list of entitlements by the Account that owns them

Input Fields

auth: Credentials required to authenticate this request
account: The account that owns the entitlement
showAll: If true, show all entitlements, including those that have expired. Otherwise, only active entitlements will be returned.

Output Fields

return: Basic results of this request (success, failure, error, etc.)
entitlements: List of entitlements for a given Account

fetchDeltaSince http://soap.vindicia.com/Entitlement#fetchDeltaSince

Input (fetchDeltaSince_in)

Name	Type
auth	Authentication
timestamp	xsd:dateTime
page	xsd:int
pageSize	xsd:int

Output (fetchDeltaSince_out)

Name	Type
return	Return
entitlements	ArrayOfEntitlements

Loads a list of entitlements that may have been affected since provided timestamp in ascending order of the time when an autobill, a billing plan, or a product changed in such a way as to affect the associated entitlements. These changes may not necessarily change active status of an entitlement depending on the time when the entitlement was fetched, but it will still be returned by this call. The latest entitlement returned by this call for an account should be considered the most up to date for that account. It is expected that merchants will make this call at appropriate regular intervals and with suitable paging parameters to limit the number of objects returned by the call

Input Fields

auth: Credentials required to authenticate this request
timestamp: Time stamp to use as search criterion
page: Page number to begin results returned, starts at 0
pageSize: Number of results to display per a page

Output Fields

return: Basic results of this request (success, failure, error, etc.)
entitlements: Array of Entitlement objects that may have been affected since the timestamp