ConsumerApi

<back to all web services

LotteryGetRequest

Consumer
Requires Authentication
Required role:Consumer
The following routes are available for this service:
GET/lottery
LotteryGetResponse Parameters:
NameParameterData TypeRequiredDescription
ActiveLotteryformActiveLotteryDtoNo
RelevantPreviousLotteryformPreviousLotteryDtoNo
ActiveLotteryDto Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
ImageUrlsformList<string>Yes
StartAtformDateTimeOffsetNo
StopAtformDateTimeOffsetNo
TitleformstringYes
DescriptionformstringYes
YourTicketCountformlongNo
PreviousLotteryDto Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
StartAtformDateTimeOffsetNo
StopAtformDateTimeOffsetNo
TitleformstringYes
YourTicketCountformlongNo
WinnerformstringYes
YouAreTheWinnerformboolNo

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

GET /lottery HTTP/1.1 
Host: consumer-api.brovs.com 
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"activeLottery":{"id":0,"imageUrls":["String"],"startAt":"0001-01-01T00:00:00.0000000+00:00","stopAt":"0001-01-01T00:00:00.0000000+00:00","title":"String","description":"String","yourTicketCount":0},"relevantPreviousLottery":{"id":0,"startAt":"0001-01-01T00:00:00.0000000+00:00","stopAt":"0001-01-01T00:00:00.0000000+00:00","title":"String","yourTicketCount":0,"winner":"String","youAreTheWinner":false}}