BackofficeApi

<back to all web services

LotteryGetRequest

Backoffice
Requires Authentication
Required role:Backoffice
The following routes are available for this service:
GET/lottery/get
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum

# module BackofficeApi


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ImageUrls:
    preview: Optional[str] = None
    small: Optional[str] = None
    medium: Optional[str] = None
    large: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class UserAddress:
    street_name: Optional[str] = None
    street_number: Optional[str] = None
    postal_code: Optional[str] = None
    region: Optional[str] = None
    country_code: Optional[str] = None


class TimeRelativeLotteryState(str, Enum):
    DRAFT = 'Draft'
    PUBLISHED_UPCOMING = 'PublishedUpcoming'
    PUBLISHED_ACTIVE = 'PublishedActive'
    PUBLISHED_ENDED_DRAW_WINNER = 'PublishedEndedDrawWinner'
    PUBLISHED_ENDED_CONTACT_WINNER = 'PublishedEndedContactWinner'
    ARCHIVED = 'Archived'


Python LotteryGetRequest DTOs

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
	}
}