| Required role: | Backoffice |
| GET | /lottery/get |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| LotteryId | query | long | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Lottery | form | LotteryDetailsDto | Yes |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | long | No | |
| StartAt | form | DateTimeOffset | No | |
| StopAt | form | DateTimeOffset | No | |
| Images | form | List<LotteryImageDto> | Yes | |
| Title | form | string | Yes | |
| Description | form | string | Yes | |
| WinnerToDisplay | form | string | No | |
| Winner | form | LotteryWinnerDto | No | |
| CountryCode | form | string | Yes | |
| State | form | TimeRelativeLotteryState | No | |
| UpdatedAt | form | DateTimeOffset | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | long | No | |
| ImageUrl | form | ImageUrls | Yes | |
| Position | form | int | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Preview | form | string | Yes | |
| Small | form | string | Yes | |
| Medium | form | string | Yes | |
| Large | form | string | Yes |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| UserId | form | long | No | |
| FirstName | form | string | No | |
| LastName | form | string | No | |
| HomeAddress | form | UserAddress | Yes | |
| MobilePhone | form | string | No | |
| MobilePhoneConfirmedAt | form | DateTimeOffset? | No | |
| form | string | No | ||
| EmailConfirmedAt | form | DateTimeOffset? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| StreetName | form | string | Yes | |
| StreetNumber | form | string | Yes | |
| PostalCode | form | string | Yes | |
| Region | form | string | Yes | |
| CountryCode | form | string | Yes |
| Draft | |
| PublishedUpcoming | |
| PublishedActive | |
| PublishedEndedDrawWinner | |
| PublishedEndedContactWinner | |
| Archived |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=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
}
}