BackofficeApi

<back to all web services

LotteryGetRequest

Backoffice
Requires Authentication
Required role:Backoffice
The following routes are available for this service:
GET/lottery/get
<?php namespace BackofficeApi;

use DateTime;
use Exception;
use DateInterval;
use JsonSerializable;
use ServiceStack\{IReturn,IReturnVoid,IGet,IPost,IPut,IDelete,IPatch,IMeta,IHasSessionId,IHasBearerToken,IHasVersion};
use ServiceStack\{ICrud,ICreateDb,IUpdateDb,IPatchDb,IDeleteDb,ISaveDb,AuditBase,QueryDb,QueryDb2,QueryData,QueryData2,QueryResponse};
use ServiceStack\{ResponseStatus,ResponseError,EmptyResponse,IdResponse,ArrayList,KeyValuePair2,StringResponse,StringsResponse,Tuple2,Tuple3,ByteArray};
use ServiceStack\{JsonConverters,Returns,TypeContext};


class ImageUrls implements JsonSerializable
{
    public function __construct(
        /** @var string */
        public string $preview='',
        /** @var string */
        public string $small='',
        /** @var string */
        public string $medium='',
        /** @var string */
        public string $large=''
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['preview'])) $this->preview = $o['preview'];
        if (isset($o['small'])) $this->small = $o['small'];
        if (isset($o['medium'])) $this->medium = $o['medium'];
        if (isset($o['large'])) $this->large = $o['large'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->preview)) $o['preview'] = $this->preview;
        if (isset($this->small)) $o['small'] = $this->small;
        if (isset($this->medium)) $o['medium'] = $this->medium;
        if (isset($this->large)) $o['large'] = $this->large;
        return empty($o) ? new class(){} : $o;
    }
}

class UserAddress implements JsonSerializable
{
    public function __construct(
        /** @var string */
        public string $streetName='',
        /** @var string */
        public string $streetNumber='',
        /** @var string */
        public string $postalCode='',
        /** @var string */
        public string $region='',
        /** @var string */
        public string $countryCode=''
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['streetName'])) $this->streetName = $o['streetName'];
        if (isset($o['streetNumber'])) $this->streetNumber = $o['streetNumber'];
        if (isset($o['postalCode'])) $this->postalCode = $o['postalCode'];
        if (isset($o['region'])) $this->region = $o['region'];
        if (isset($o['countryCode'])) $this->countryCode = $o['countryCode'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->streetName)) $o['streetName'] = $this->streetName;
        if (isset($this->streetNumber)) $o['streetNumber'] = $this->streetNumber;
        if (isset($this->postalCode)) $o['postalCode'] = $this->postalCode;
        if (isset($this->region)) $o['region'] = $this->region;
        if (isset($this->countryCode)) $o['countryCode'] = $this->countryCode;
        return empty($o) ? new class(){} : $o;
    }
}

enum TimeRelativeLotteryState : string
{
    case Draft = 'Draft';
    case PublishedUpcoming = 'PublishedUpcoming';
    case PublishedActive = 'PublishedActive';
    case PublishedEndedDrawWinner = 'PublishedEndedDrawWinner';
    case PublishedEndedContactWinner = 'PublishedEndedContactWinner';
    case Archived = 'Archived';
}

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