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