BackofficeApi

<back to all web services

LotteryGetRequest

Backoffice
Requires Authentication
Required role:Backoffice
The following routes are available for this service:
GET/lottery/get

export module BackofficeApi
{
    // @ts-nocheck

    export class ImageUrls
    {
        public preview: string;
        public small: string;
        public medium: string;
        public large: string;

        public constructor(init?: Partial<ImageUrls>) { (Object as any).assign(this, init); }
    }

    export class UserAddress
    {
        public streetName: string;
        public streetNumber: string;
        public postalCode: string;
        public region: string;
        public countryCode: string;

        public constructor(init?: Partial<UserAddress>) { (Object as any).assign(this, init); }
    }

    export enum TimeRelativeLotteryState
    {
        Draft = 'Draft',
        PublishedUpcoming = 'PublishedUpcoming',
        PublishedActive = 'PublishedActive',
        PublishedEndedDrawWinner = 'PublishedEndedDrawWinner',
        PublishedEndedContactWinner = 'PublishedEndedContactWinner',
        Archived = 'Archived',
    }

}

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