ConsumerApi

<back to all web services

GetRewardsStatusRequest

Consumer
Requires Authentication
The following routes are available for this service:
GET/user/rewards
GetRewardsStatusResponse Parameters:
NameParameterData TypeRequiredDescription
PointsInTotalformlongNo
PointsExpiringAtEndOfThisYearformlongNo
ReferFriendformRewardInfoYes
SharePlaceformRewardInfoYes
ShareAdMessageformRewardInfoYes
ReferBusinessformRewardInfoYes
PointsAwardedForSignupformlongNo
ActiveLotteryformActiveLotteryNo
RewardInfo Parameters:
NameParameterData TypeRequiredDescription
PointsformlongNo
CountformlongNo
PointsGrantedOnSuccessformlongNo
ActiveLottery Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
FirstDayformDateTimeOffsetNo
LastDayformDateTimeOffsetNo
ContentBeforeSharingformstringNo
ContentAfterSharingformstringNo
CountryCodeformstringYes
YourNumberOfTicketsInThisLotteryformlongNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /user/rewards HTTP/1.1 
Host: consumer-api.brovs.com 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	pointsInTotal: 0,
	pointsExpiringAtEndOfThisYear: 0,
	referFriend: 
	{
		points: 0,
		count: 0,
		pointsGrantedOnSuccess: 0
	},
	sharePlace: 
	{
		points: 0,
		count: 0,
		pointsGrantedOnSuccess: 0
	},
	shareAdMessage: 
	{
		points: 0,
		count: 0,
		pointsGrantedOnSuccess: 0
	},
	referBusiness: 
	{
		points: 0,
		count: 0,
		pointsGrantedOnSuccess: 0
	},
	pointsAwardedForSignup: 0,
	activeLottery: 
	{
		id: 0,
		firstDay: 0001-01-01T00:00:00.0000000+00:00,
		lastDay: 0001-01-01T00:00:00.0000000+00:00,
		contentBeforeSharing: String,
		contentAfterSharing: String,
		countryCode: String,
		yourNumberOfTicketsInThisLottery: 0
	}
}