BusinessApi

<back to all web services

GetAdMessagesRequest

Business
Requires Authentication
Required role:Business
The following routes are available for this service:
GET/admessage/get_all
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


enum class VisibilityState
{
    Draft,
    Running,
    Upcoming,
    Archived,
    Paused,
}

open class ImageUrls
{
    open var preview:String? = null
    open var small:String? = null
    open var medium:String? = null
    open var large:String? = null
}

open class OpeningHours
{
    open var weekly:WeeklyOpeningHours? = null
}

open class WeeklyOpeningHours
{
    open var monday:OpeningHour? = null
    open var tuesday:OpeningHour? = null
    open var wednesday:OpeningHour? = null
    open var thursday:OpeningHour? = null
    open var friday:OpeningHour? = null
    open var saturday:OpeningHour? = null
    open var sunday:OpeningHour? = null
}

open class OpeningHour
{
    open var openAtHour:Int? = null
    open var openAtMinute:Int? = null
    open var closeAtHour:Int? = null
    open var closeAtMinute:Int? = null
}

enum class PlaceType
{
    Mall,
    Regular,
}

open class PlaceContact
{
    open var phone:String? = null
    open var email:String? = null
    open var website:String? = null
    open var webShop:String? = null
}

open class PlaceAddress
{
    open var street:String? = null
    open var postalCode:String? = null
    open var region:String? = null
    open var countryCode:String? = null
}

open class TimeZoneDto
{
    open var baseUtcOffset:TimeSpan? = null
    open var daylightName:String? = null
    open var displayName:String? = null
    open var id:String? = null
    open var standardName:String? = null
    open var supportsDaylightSavingTime:Boolean? = null
}

open class PriceMainDishDto
{
    open var title:String? = null
    open var slug:PriceMainDish? = null
}

enum class PriceMainDish
{
    Value,
    Medium,
    High,
    FineDining,
}

open class AdMessageDetailsUnion
{
    open var percentageOnAllMerchandise:AdMessageDetailsPercentageDiscountOnAllMerchandise? = null
    open var percentageRangeOnAllMerchandise:AdMessageDetailsPercentageDiscountRangeOnAllMerchandise? = null
    open var percentageOnSelectedMerchandise:AdMessageDetailsPercentageDiscountOnSelectedMerchandise? = null
    open var absoluteOnSelectedMerchandise:AdMessageDetailsAbsoluteDiscountOnSelectedMerchandise? = null
    open var absoluteRangeOnAllMerchandise:AdMessageDetailsAbsoluteDiscountRangeOnAllMerchandise? = null
    open var totalAmountOverXgivesYdiscount:AdMessageDetailsTotalAmountOverXgivesYdiscount? = null
    open var xforY:AdMessageDetailsXforYdiscount? = null
    open var newArrivals:AdMessageDetailsNewArrivals? = null
    open var freetext:AdMessageDetailsFreetext? = null
    open var todaysBreakFastOffer:AdMessageDetailsTodaysBreakFastOffer? = null
    open var todaysLunchOffer:AdMessageDetailsTodaysLunchOffer? = null
    open var todaysDinnerOffer:AdMessageDetailsTodaysDinnerOffer? = null
    open var saveFoodAndMoney:AdMessageDetailsSaveFoodAndMoney? = null
    open var percentageOfYourFoodBill:AdMessageDetailsPercentageOffYourFoodBill? = null
    open var happyHour:AdMessageDetailsHappyHour? = null
    open var someFreeTablesLeftToday:AdMessageDetailsSomeFreeTablesLeftToday? = null
    open var twoDishesForThePriceOfOne:AdMessageDetailsTwoDishesForThePriceOfOne? = null
}

open class AdMessageDetailsPercentageDiscountOnAllMerchandise : AdMessageDetailsBase()
{
    open var value:Double? = null
}

open class AdMessageDetailsBase
{
    open var description:String? = null
    open var moreInformation:ArrayList<String> = ArrayList<String>()
}

open class AdMessageDetailsPercentageDiscountRangeOnAllMerchandise : AdMessageDetailsBase()
{
    open var start:Double? = null
    open var stop:Double? = null
}

open class AdMessageDetailsPercentageDiscountOnSelectedMerchandise : AdMessageDetailsBase()
{
    open var value:Double? = null
}

open class AdMessageDetailsAbsoluteDiscountOnSelectedMerchandise : AdMessageDetailsBase()
{
    open var value:Double? = null
}

open class AdMessageDetailsAbsoluteDiscountRangeOnAllMerchandise : AdMessageDetailsBase()
{
    open var start:Double? = null
    open var stop:Double? = null
}

open class AdMessageDetailsTotalAmountOverXgivesYdiscount : AdMessageDetailsBase()
{
    open var ifTotalAmountMoreThanX:Double? = null
    open var thenYouGetDiscountPercentageY:Double? = null
}

open class AdMessageDetailsXforYdiscount : AdMessageDetailsBase()
{
    open var ifYouBuyX:Int? = null
    open var thenYouGetY:Int? = null
}

open class AdMessageDetailsNewArrivals : AdMessageDetailsBase()
{
}

open class AdMessageDetailsFreetext : AdMessageDetailsBase()
{
    open var title:String? = null
}

open class AdMessageDetailsTodaysBreakFastOffer : AdMessageDetailsBase()
{
    open var value:Double? = null
}

open class AdMessageDetailsTodaysLunchOffer : AdMessageDetailsBase()
{
    open var value:Double? = null
}

open class AdMessageDetailsTodaysDinnerOffer : AdMessageDetailsBase()
{
    open var value:Double? = null
}

open class AdMessageDetailsSaveFoodAndMoney : AdMessageDetailsBase()
{
    open var value:Double? = null
}

open class AdMessageDetailsPercentageOffYourFoodBill : AdMessageDetailsBase()
{
    open var percentage:Double? = null
}

open class AdMessageDetailsHappyHour : AdMessageDetailsBase()
{
}

open class AdMessageDetailsSomeFreeTablesLeftToday : AdMessageDetailsBase()
{
}

open class AdMessageDetailsTwoDishesForThePriceOfOne : AdMessageDetailsBase()
{
}

Kotlin GetAdMessagesRequest 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 /admessage/get_all HTTP/1.1 
Host: business-api.brovs.com 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	adMessagesWithVisibilityState: 
	[
		{
			id: 0,
			title: String,
			startAt: 
			{
				year: 0,
				month: 0,
				day: 0,
				hour: 0,
				minute: 0,
				second: 0
			},
			stopAt: 
			{
				year: 0,
				month: 0,
				day: 0,
				hour: 0,
				minute: 0,
				second: 0
			},
			publishAt: 
			{
				year: 0,
				month: 0,
				day: 0,
				hour: 0,
				minute: 0,
				second: 0
			},
			state: String,
			updatedAt: 0001-01-01T00:00:00.0000000+00:00,
			imageUrls: 
			[
				{
					preview: String,
					small: String,
					medium: String,
					large: String
				}
			],
			place: 
			{
				id: 0,
				name: String,
				businessId: 0,
				longitude: 0,
				latitude: 0,
				claimed: False,
				organizationNumber: String,
				countryCode: String,
				overview: String,
				openingHours: 
				{
					weekly: 
					{
						monday: 
						{
							openAtHour: 0,
							openAtMinute: 0,
							closeAtHour: 0,
							closeAtMinute: 0
						},
						tuesday: 
						{
							openAtHour: 0,
							openAtMinute: 0,
							closeAtHour: 0,
							closeAtMinute: 0
						},
						wednesday: 
						{
							openAtHour: 0,
							openAtMinute: 0,
							closeAtHour: 0,
							closeAtMinute: 0
						},
						thursday: 
						{
							openAtHour: 0,
							openAtMinute: 0,
							closeAtHour: 0,
							closeAtMinute: 0
						},
						friday: 
						{
							openAtHour: 0,
							openAtMinute: 0,
							closeAtHour: 0,
							closeAtMinute: 0
						},
						saturday: 
						{
							openAtHour: 0,
							openAtMinute: 0,
							closeAtHour: 0,
							closeAtMinute: 0
						},
						sunday: 
						{
							openAtHour: 0,
							openAtMinute: 0,
							closeAtHour: 0,
							closeAtMinute: 0
						}
					}
				},
				placeType: Mall,
				contact: 
				{
					phone: String,
					email: String,
					website: String,
					webShop: String
				},
				address: 
				{
					street: String,
					postalCode: String,
					region: String,
					countryCode: String
				},
				wheelChairAccessible: False,
				wifi: False,
				outdoorSeating: False,
				saveFoodAndMoney: False,
				timeZoneDto: 
				{
					baseUtcOffset: PT0S,
					daylightName: String,
					displayName: String,
					id: String,
					standardName: String,
					supportsDaylightSavingTime: False
				},
				priceMainDish: 
				{
					title: String,
					slug: Value
				},
				otherServices: 
				[
					{
						id: 0,
						serviceName: String,
						floor: String
					}
				],
				floor: String
			},
			detailsUnion: 
			{
				percentageOnAllMerchandise: 
				{
					value: 0,
					description: String,
					moreInformation: 
					[
						String
					]
				},
				percentageRangeOnAllMerchandise: 
				{
					start: 0,
					stop: 0,
					description: String,
					moreInformation: 
					[
						String
					]
				},
				percentageOnSelectedMerchandise: 
				{
					value: 0,
					description: String,
					moreInformation: 
					[
						String
					]
				},
				absoluteOnSelectedMerchandise: 
				{
					value: 0,
					description: String,
					moreInformation: 
					[
						String
					]
				},
				absoluteRangeOnAllMerchandise: 
				{
					start: 0,
					stop: 0,
					description: String,
					moreInformation: 
					[
						String
					]
				},
				totalAmountOverXgivesYdiscount: 
				{
					ifTotalAmountMoreThanX: 0,
					thenYouGetDiscountPercentageY: 0,
					description: String,
					moreInformation: 
					[
						String
					]
				},
				xforY: 
				{
					ifYouBuyX: 0,
					thenYouGetY: 0,
					description: String,
					moreInformation: 
					[
						String
					]
				},
				newArrivals: 
				{
					description: String,
					moreInformation: 
					[
						String
					]
				},
				freetext: 
				{
					title: String,
					description: String,
					moreInformation: 
					[
						String
					]
				},
				todaysBreakFastOffer: 
				{
					value: 0,
					description: String,
					moreInformation: 
					[
						String
					]
				},
				todaysLunchOffer: 
				{
					value: 0,
					description: String,
					moreInformation: 
					[
						String
					]
				},
				todaysDinnerOffer: 
				{
					value: 0,
					description: String,
					moreInformation: 
					[
						String
					]
				},
				saveFoodAndMoney: 
				{
					value: 0,
					description: String,
					moreInformation: 
					[
						String
					]
				},
				percentageOfYourFoodBill: 
				{
					percentage: 0,
					description: String,
					moreInformation: 
					[
						String
					]
				},
				happyHour: 
				{
					description: String,
					moreInformation: 
					[
						String
					]
				},
				someFreeTablesLeftToday: 
				{
					description: String,
					moreInformation: 
					[
						String
					]
				},
				twoDishesForThePriceOfOne: 
				{
					description: String,
					moreInformation: 
					[
						String
					]
				}
			}
		}
	]
}