BackofficeApi

<back to all web services

LotteryGetRequest

Backoffice
Requires Authentication
Required role:Backoffice
The following routes are available for this service:
GET/lottery/get
"use strict";
export class ImageUrls {
    /** @param {{preview?:string,small?:string,medium?:string,large?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    preview;
    /** @type {string} */
    small;
    /** @type {string} */
    medium;
    /** @type {string} */
    large;
}
export class UserAddress {
    /** @param {{streetName?:string,streetNumber?:string,postalCode?:string,region?:string,countryCode?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    streetName;
    /** @type {string} */
    streetNumber;
    /** @type {string} */
    postalCode;
    /** @type {string} */
    region;
    /** @type {string} */
    countryCode;
}
/** @typedef {'Draft'|'PublishedUpcoming'|'PublishedActive'|'PublishedEndedDrawWinner'|'PublishedEndedContactWinner'|'Archived'} */
export var TimeRelativeLotteryState;
(function (TimeRelativeLotteryState) {
    TimeRelativeLotteryState["Draft"] = "Draft"
    TimeRelativeLotteryState["PublishedUpcoming"] = "PublishedUpcoming"
    TimeRelativeLotteryState["PublishedActive"] = "PublishedActive"
    TimeRelativeLotteryState["PublishedEndedDrawWinner"] = "PublishedEndedDrawWinner"
    TimeRelativeLotteryState["PublishedEndedContactWinner"] = "PublishedEndedContactWinner"
    TimeRelativeLotteryState["Archived"] = "Archived"
})(TimeRelativeLotteryState || (TimeRelativeLotteryState = {}));

JavaScript LotteryGetRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other

HTTP + OTHER

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