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 .xml suffix or ?format=xml

HTTP + XML

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: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<LotteryGetResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BackofficeApi.Dto">
  <Lottery>
    <CountryCode>String</CountryCode>
    <Description>String</Description>
    <Id>0</Id>
    <Images>
      <LotteryImageDto>
        <Id>0</Id>
        <ImageUrl xmlns:d5p1="http://schemas.datacontract.org/2004/07/Entities.Common">
          <d5p1:Large>String</d5p1:Large>
          <d5p1:Medium>String</d5p1:Medium>
          <d5p1:Preview>String</d5p1:Preview>
          <d5p1:Small>String</d5p1:Small>
        </ImageUrl>
        <Position>0</Position>
      </LotteryImageDto>
    </Images>
    <StartAt xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
      <d3p1:DateTime>0001-01-01T00:00:00Z</d3p1:DateTime>
      <d3p1:OffsetMinutes>0</d3p1:OffsetMinutes>
    </StartAt>
    <State>Draft</State>
    <StopAt xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
      <d3p1:DateTime>0001-01-01T00:00:00Z</d3p1:DateTime>
      <d3p1:OffsetMinutes>0</d3p1:OffsetMinutes>
    </StopAt>
    <Title>String</Title>
    <UpdatedAt xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
      <d3p1:DateTime>0001-01-01T00:00:00Z</d3p1:DateTime>
      <d3p1:OffsetMinutes>0</d3p1:OffsetMinutes>
    </UpdatedAt>
    <Winner>
      <Email>String</Email>
      <EmailConfirmedAt xmlns:d4p1="http://schemas.datacontract.org/2004/07/System">
        <d4p1:DateTime>0001-01-01T00:00:00Z</d4p1:DateTime>
        <d4p1:OffsetMinutes>0</d4p1:OffsetMinutes>
      </EmailConfirmedAt>
      <FirstName>String</FirstName>
      <HomeAddress xmlns:d4p1="http://schemas.datacontract.org/2004/07/Entities.Common">
        <d4p1:CountryCode>String</d4p1:CountryCode>
        <d4p1:PostalCode>String</d4p1:PostalCode>
        <d4p1:Region>String</d4p1:Region>
        <d4p1:StreetName>String</d4p1:StreetName>
        <d4p1:StreetNumber>String</d4p1:StreetNumber>
      </HomeAddress>
      <LastName>String</LastName>
      <MobilePhone>String</MobilePhone>
      <MobilePhoneConfirmedAt xmlns:d4p1="http://schemas.datacontract.org/2004/07/System">
        <d4p1:DateTime>0001-01-01T00:00:00Z</d4p1:DateTime>
        <d4p1:OffsetMinutes>0</d4p1:OffsetMinutes>
      </MobilePhoneConfirmedAt>
      <UserId>0</UserId>
    </Winner>
    <WinnerToDisplay>String</WinnerToDisplay>
  </Lottery>
</LotteryGetResponse>