RedeemReward

The RedeemReward web service XML- or JSON-based information exchange systems that use the Internet for direct application-to-application interaction. These systems can include programs, objects, messages, or documents. enables an external application to display possible rewards and allow the subscriber The end user of a network. to redeem the reward they want.

This web service is invoked after the QuerySubscription web service response dataset REWARD_ENTITLEMENTS has been invoked.

When the RedeemReward web service is invoked it is possible to override a subscriber's default reward category if required, see Set Default Reward Category for details.

RedeemReward Request

The RedeemReward tag instructs the Rewards Service to enable an external application to display possible rewards and allow the customer In the context of the Cloud Monetisation Platform, an individual or organisation who has signed an agreement to take goods and services from a service provider. A customer receives a bill associated with one or more subscriptions, and can be a single end user or a large company with many subscriptions assigned to one agreement. to redeem the reward they want. This request contains the following elements:

Element Name	Content Type	Description	Required?
ExternalReference	String69	The client may use this identifier to correlate the request and the response.	Optional
RewardIdentifier	Integer9	Code to identify the reward that is to be claimed.	Mandatory
SetCategory	Container	See SetCategory Request Container for details.	Optional
LastAmendedDate	dateTime	Date on which the Subscription was last amended.	Mandatory
AuditRecord	Container	See AuditRecord Request Container for details.	Optional

SetCategory Request Container

The SetCategory request container has the following elements:

Element Name	Content Type	Description	Required?
RewardCategory	String	The category of reward e.g. minutes, text, data, money, other.	Mandatory
SetAsDefaultCategory	Boolean	Indicates if this Reward Category is to be set as the default one on Customer Default Reward Category file.	Mandatory

AuditRecord Request Container

The AuditRecord request container has the following elements:

Element Name	Content Type	Description	Required?
UserID	String10	User ID associated with the profile. This is the ID which the calling program adds to the records that are created.	Mandatory
Program	String10	The Program Name should be hard coded in the calling application to uniquely identify that application.	Mandatory

Sample RedeemReward Request

RedeemReward Response

The RedeemReward response is the response to the RedeemReward request. This contains the following elements:

Element Name	Content Type	Description	Required?
ExternalReference	String69	Returned unmodified in the response. The client may use this identifier to correlate the request and the response.	Optional

Sample RedeemReward Response