BackofficeApi

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

HTTP + CSV

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/csv

HTTP/1.1 200 OK
Content-Type: text/csv
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"}}