BackofficeApi

<back to all web services

LotteryGetRequest

Backoffice
Requires Authentication
Required role:Backoffice
The following routes are available for this service:
GET/lottery/get
LotteryGetRequest Parameters:
NameParameterData TypeRequiredDescription
LotteryIdquerylongNo
LotteryGetResponse Parameters:
NameParameterData TypeRequiredDescription
LotteryformLotteryDetailsDtoYes
LotteryDetailsDto Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
StartAtformDateTimeOffsetNo
StopAtformDateTimeOffsetNo
ImagesformList<LotteryImageDto>Yes
TitleformstringYes
DescriptionformstringYes
WinnerToDisplayformstringNo
WinnerformLotteryWinnerDtoNo
CountryCodeformstringYes
StateformTimeRelativeLotteryStateNo
UpdatedAtformDateTimeOffsetNo
LotteryImageDto Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
ImageUrlformImageUrlsYes
PositionformintNo
ImageUrls Parameters:
NameParameterData TypeRequiredDescription
PreviewformstringYes
SmallformstringYes
MediumformstringYes
LargeformstringYes
LotteryWinnerDto Parameters:
NameParameterData TypeRequiredDescription
UserIdformlongNo
FirstNameformstringNo
LastNameformstringNo
HomeAddressformUserAddressYes
MobilePhoneformstringNo
MobilePhoneConfirmedAtformDateTimeOffset?No
EmailformstringNo
EmailConfirmedAtformDateTimeOffset?No
UserAddress Parameters:
NameParameterData TypeRequiredDescription
StreetNameformstringYes
StreetNumberformstringYes
PostalCodeformstringYes
RegionformstringYes
CountryCodeformstringYes
TimeRelativeLotteryState Enum:
Draft
PublishedUpcoming
PublishedActive
PublishedEndedDrawWinner
PublishedEndedContactWinner
Archived

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 /lottery/get HTTP/1.1 
Host: backoffice-api.brovs.com 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	lottery: 
	{
		id: 0,
		startAt: 0001-01-01T00:00:00.0000000+00:00,
		stopAt: 0001-01-01T00:00:00.0000000+00:00,
		images: 
		[
			{
				id: 0,
				imageUrl: 
				{
					preview: String,
					small: String,
					medium: String,
					large: String
				},
				position: 0
			}
		],
		title: String,
		description: String,
		winnerToDisplay: String,
		winner: 
		{
			userId: 0,
			firstName: String,
			lastName: String,
			homeAddress: 
			{
				streetName: String,
				streetNumber: String,
				postalCode: String,
				region: String,
				countryCode: String
			},
			mobilePhone: String,
			mobilePhoneConfirmedAt: 0001-01-01T00:00:00.0000000+00:00,
			email: String,
			emailConfirmedAt: 0001-01-01T00:00:00.0000000+00:00
		},
		countryCode: String,
		state: Draft,
		updatedAt: 0001-01-01T00:00:00.0000000+00:00
	}
}