BusinessApi

<back to all web services

GetAdMessageRequest

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

public class BusinessApi
{

    public static class ImageUrls
    {
        public String preview = null;
        public String small = null;
        public String medium = null;
        public String large = null;
        
        public String getPreview() { return preview; }
        public ImageUrls setPreview(String value) { this.preview = value; return this; }
        public String getSmall() { return small; }
        public ImageUrls setSmall(String value) { this.small = value; return this; }
        public String getMedium() { return medium; }
        public ImageUrls setMedium(String value) { this.medium = value; return this; }
        public String getLarge() { return large; }
        public ImageUrls setLarge(String value) { this.large = value; return this; }
    }

    public static class OpeningHours
    {
        public WeeklyOpeningHours weekly = null;
        
        public WeeklyOpeningHours getWeekly() { return weekly; }
        public OpeningHours setWeekly(WeeklyOpeningHours value) { this.weekly = value; return this; }
    }

    public static class WeeklyOpeningHours
    {
        public OpeningHour monday = null;
        public OpeningHour tuesday = null;
        public OpeningHour wednesday = null;
        public OpeningHour thursday = null;
        public OpeningHour friday = null;
        public OpeningHour saturday = null;
        public OpeningHour sunday = null;
        
        public OpeningHour getMonday() { return monday; }
        public WeeklyOpeningHours setMonday(OpeningHour value) { this.monday = value; return this; }
        public OpeningHour getTuesday() { return tuesday; }
        public WeeklyOpeningHours setTuesday(OpeningHour value) { this.tuesday = value; return this; }
        public OpeningHour getWednesday() { return wednesday; }
        public WeeklyOpeningHours setWednesday(OpeningHour value) { this.wednesday = value; return this; }
        public OpeningHour getThursday() { return thursday; }
        public WeeklyOpeningHours setThursday(OpeningHour value) { this.thursday = value; return this; }
        public OpeningHour getFriday() { return friday; }
        public WeeklyOpeningHours setFriday(OpeningHour value) { this.friday = value; return this; }
        public OpeningHour getSaturday() { return saturday; }
        public WeeklyOpeningHours setSaturday(OpeningHour value) { this.saturday = value; return this; }
        public OpeningHour getSunday() { return sunday; }
        public WeeklyOpeningHours setSunday(OpeningHour value) { this.sunday = value; return this; }
    }

    public static class OpeningHour
    {
        public Integer openAtHour = null;
        public Integer openAtMinute = null;
        public Integer closeAtHour = null;
        public Integer closeAtMinute = null;
        
        public Integer getOpenAtHour() { return openAtHour; }
        public OpeningHour setOpenAtHour(Integer value) { this.openAtHour = value; return this; }
        public Integer getOpenAtMinute() { return openAtMinute; }
        public OpeningHour setOpenAtMinute(Integer value) { this.openAtMinute = value; return this; }
        public Integer getCloseAtHour() { return closeAtHour; }
        public OpeningHour setCloseAtHour(Integer value) { this.closeAtHour = value; return this; }
        public Integer getCloseAtMinute() { return closeAtMinute; }
        public OpeningHour setCloseAtMinute(Integer value) { this.closeAtMinute = value; return this; }
    }

    public static enum PlaceType
    {
        Mall,
        Regular;
    }

    public static class PlaceContact
    {
        public String phone = null;
        public String email = null;
        public String website = null;
        public String webShop = null;
        
        public String getPhone() { return phone; }
        public PlaceContact setPhone(String value) { this.phone = value; return this; }
        public String getEmail() { return email; }
        public PlaceContact setEmail(String value) { this.email = value; return this; }
        public String getWebsite() { return website; }
        public PlaceContact setWebsite(String value) { this.website = value; return this; }
        public String getWebShop() { return webShop; }
        public PlaceContact setWebShop(String value) { this.webShop = value; return this; }
    }

    public static class PlaceAddress
    {
        public String street = null;
        public String postalCode = null;
        public String region = null;
        public String countryCode = null;
        
        public String getStreet() { return street; }
        public PlaceAddress setStreet(String value) { this.street = value; return this; }
        public String getPostalCode() { return postalCode; }
        public PlaceAddress setPostalCode(String value) { this.postalCode = value; return this; }
        public String getRegion() { return region; }
        public PlaceAddress setRegion(String value) { this.region = value; return this; }
        public String getCountryCode() { return countryCode; }
        public PlaceAddress setCountryCode(String value) { this.countryCode = value; return this; }
    }

    public static class TimeZoneDto
    {
        public TimeSpan baseUtcOffset = null;
        public String daylightName = null;
        public String displayName = null;
        public String id = null;
        public String standardName = null;
        public Boolean supportsDaylightSavingTime = null;
        
        public TimeSpan getBaseUtcOffset() { return baseUtcOffset; }
        public TimeZoneDto setBaseUtcOffset(TimeSpan value) { this.baseUtcOffset = value; return this; }
        public String getDaylightName() { return daylightName; }
        public TimeZoneDto setDaylightName(String value) { this.daylightName = value; return this; }
        public String getDisplayName() { return displayName; }
        public TimeZoneDto setDisplayName(String value) { this.displayName = value; return this; }
        public String getId() { return id; }
        public TimeZoneDto setId(String value) { this.id = value; return this; }
        public String getStandardName() { return standardName; }
        public TimeZoneDto setStandardName(String value) { this.standardName = value; return this; }
        public Boolean isSupportsDaylightSavingTime() { return supportsDaylightSavingTime; }
        public TimeZoneDto setSupportsDaylightSavingTime(Boolean value) { this.supportsDaylightSavingTime = value; return this; }
    }

    public static class PriceMainDishDto
    {
        public String title = null;
        public PriceMainDish slug = null;
        
        public String getTitle() { return title; }
        public PriceMainDishDto setTitle(String value) { this.title = value; return this; }
        public PriceMainDish getSlug() { return slug; }
        public PriceMainDishDto setSlug(PriceMainDish value) { this.slug = value; return this; }
    }

    public static enum PriceMainDish
    {
        Value,
        Medium,
        High,
        FineDining;
    }

    public static class AdMessageDetailsUnion
    {
        public AdMessageDetailsPercentageDiscountOnAllMerchandise percentageOnAllMerchandise = null;
        public AdMessageDetailsPercentageDiscountRangeOnAllMerchandise percentageRangeOnAllMerchandise = null;
        public AdMessageDetailsPercentageDiscountOnSelectedMerchandise percentageOnSelectedMerchandise = null;
        public AdMessageDetailsAbsoluteDiscountOnSelectedMerchandise absoluteOnSelectedMerchandise = null;
        public AdMessageDetailsAbsoluteDiscountRangeOnAllMerchandise absoluteRangeOnAllMerchandise = null;
        public AdMessageDetailsTotalAmountOverXgivesYdiscount totalAmountOverXgivesYdiscount = null;
        public AdMessageDetailsXforYdiscount xforY = null;
        public AdMessageDetailsNewArrivals newArrivals = null;
        public AdMessageDetailsFreetext freetext = null;
        public AdMessageDetailsTodaysBreakFastOffer todaysBreakFastOffer = null;
        public AdMessageDetailsTodaysLunchOffer todaysLunchOffer = null;
        public AdMessageDetailsTodaysDinnerOffer todaysDinnerOffer = null;
        public AdMessageDetailsSaveFoodAndMoney saveFoodAndMoney = null;
        public AdMessageDetailsPercentageOffYourFoodBill percentageOfYourFoodBill = null;
        public AdMessageDetailsHappyHour happyHour = null;
        public AdMessageDetailsSomeFreeTablesLeftToday someFreeTablesLeftToday = null;
        public AdMessageDetailsTwoDishesForThePriceOfOne twoDishesForThePriceOfOne = null;
        
        public AdMessageDetailsPercentageDiscountOnAllMerchandise getPercentageOnAllMerchandise() { return percentageOnAllMerchandise; }
        public AdMessageDetailsUnion setPercentageOnAllMerchandise(AdMessageDetailsPercentageDiscountOnAllMerchandise value) { this.percentageOnAllMerchandise = value; return this; }
        public AdMessageDetailsPercentageDiscountRangeOnAllMerchandise getPercentageRangeOnAllMerchandise() { return percentageRangeOnAllMerchandise; }
        public AdMessageDetailsUnion setPercentageRangeOnAllMerchandise(AdMessageDetailsPercentageDiscountRangeOnAllMerchandise value) { this.percentageRangeOnAllMerchandise = value; return this; }
        public AdMessageDetailsPercentageDiscountOnSelectedMerchandise getPercentageOnSelectedMerchandise() { return percentageOnSelectedMerchandise; }
        public AdMessageDetailsUnion setPercentageOnSelectedMerchandise(AdMessageDetailsPercentageDiscountOnSelectedMerchandise value) { this.percentageOnSelectedMerchandise = value; return this; }
        public AdMessageDetailsAbsoluteDiscountOnSelectedMerchandise getAbsoluteOnSelectedMerchandise() { return absoluteOnSelectedMerchandise; }
        public AdMessageDetailsUnion setAbsoluteOnSelectedMerchandise(AdMessageDetailsAbsoluteDiscountOnSelectedMerchandise value) { this.absoluteOnSelectedMerchandise = value; return this; }
        public AdMessageDetailsAbsoluteDiscountRangeOnAllMerchandise getAbsoluteRangeOnAllMerchandise() { return absoluteRangeOnAllMerchandise; }
        public AdMessageDetailsUnion setAbsoluteRangeOnAllMerchandise(AdMessageDetailsAbsoluteDiscountRangeOnAllMerchandise value) { this.absoluteRangeOnAllMerchandise = value; return this; }
        public AdMessageDetailsTotalAmountOverXgivesYdiscount getTotalAmountOverXgivesYdiscount() { return totalAmountOverXgivesYdiscount; }
        public AdMessageDetailsUnion setTotalAmountOverXgivesYdiscount(AdMessageDetailsTotalAmountOverXgivesYdiscount value) { this.totalAmountOverXgivesYdiscount = value; return this; }
        public AdMessageDetailsXforYdiscount getXforY() { return xforY; }
        public AdMessageDetailsUnion setXforY(AdMessageDetailsXforYdiscount value) { this.xforY = value; return this; }
        public AdMessageDetailsNewArrivals getNewArrivals() { return newArrivals; }
        public AdMessageDetailsUnion setNewArrivals(AdMessageDetailsNewArrivals value) { this.newArrivals = value; return this; }
        public AdMessageDetailsFreetext getFreetext() { return freetext; }
        public AdMessageDetailsUnion setFreetext(AdMessageDetailsFreetext value) { this.freetext = value; return this; }
        public AdMessageDetailsTodaysBreakFastOffer getTodaysBreakFastOffer() { return todaysBreakFastOffer; }
        public AdMessageDetailsUnion setTodaysBreakFastOffer(AdMessageDetailsTodaysBreakFastOffer value) { this.todaysBreakFastOffer = value; return this; }
        public AdMessageDetailsTodaysLunchOffer getTodaysLunchOffer() { return todaysLunchOffer; }
        public AdMessageDetailsUnion setTodaysLunchOffer(AdMessageDetailsTodaysLunchOffer value) { this.todaysLunchOffer = value; return this; }
        public AdMessageDetailsTodaysDinnerOffer getTodaysDinnerOffer() { return todaysDinnerOffer; }
        public AdMessageDetailsUnion setTodaysDinnerOffer(AdMessageDetailsTodaysDinnerOffer value) { this.todaysDinnerOffer = value; return this; }
        public AdMessageDetailsSaveFoodAndMoney getSaveFoodAndMoney() { return saveFoodAndMoney; }
        public AdMessageDetailsUnion setSaveFoodAndMoney(AdMessageDetailsSaveFoodAndMoney value) { this.saveFoodAndMoney = value; return this; }
        public AdMessageDetailsPercentageOffYourFoodBill getPercentageOfYourFoodBill() { return percentageOfYourFoodBill; }
        public AdMessageDetailsUnion setPercentageOfYourFoodBill(AdMessageDetailsPercentageOffYourFoodBill value) { this.percentageOfYourFoodBill = value; return this; }
        public AdMessageDetailsHappyHour getHappyHour() { return happyHour; }
        public AdMessageDetailsUnion setHappyHour(AdMessageDetailsHappyHour value) { this.happyHour = value; return this; }
        public AdMessageDetailsSomeFreeTablesLeftToday getSomeFreeTablesLeftToday() { return someFreeTablesLeftToday; }
        public AdMessageDetailsUnion setSomeFreeTablesLeftToday(AdMessageDetailsSomeFreeTablesLeftToday value) { this.someFreeTablesLeftToday = value; return this; }
        public AdMessageDetailsTwoDishesForThePriceOfOne getTwoDishesForThePriceOfOne() { return twoDishesForThePriceOfOne; }
        public AdMessageDetailsUnion setTwoDishesForThePriceOfOne(AdMessageDetailsTwoDishesForThePriceOfOne value) { this.twoDishesForThePriceOfOne = value; return this; }
    }

    public static class AdMessageDetailsPercentageDiscountOnAllMerchandise extends AdMessageDetailsBase
    {
        public Double value = null;
        
        public Double getValue() { return value; }
        public AdMessageDetailsPercentageDiscountOnAllMerchandise setValue(Double value) { this.value = value; return this; }
    }

    public static class AdMessageDetailsBase
    {
        public String description = null;
        public ArrayList<String> moreInformation = new ArrayList<String>();
        
        public String getDescription() { return description; }
        public AdMessageDetailsBase setDescription(String value) { this.description = value; return this; }
        public ArrayList<String> getMoreInformation() { return moreInformation; }
        public AdMessageDetailsBase setMoreInformation(ArrayList<String> value) { this.moreInformation = value; return this; }
    }

    public static class AdMessageDetailsPercentageDiscountRangeOnAllMerchandise extends AdMessageDetailsBase
    {
        public Double start = null;
        public Double stop = null;
        
        public Double getStart() { return start; }
        public AdMessageDetailsPercentageDiscountRangeOnAllMerchandise setStart(Double value) { this.start = value; return this; }
        public Double getStop() { return stop; }
        public AdMessageDetailsPercentageDiscountRangeOnAllMerchandise setStop(Double value) { this.stop = value; return this; }
    }

    public static class AdMessageDetailsPercentageDiscountOnSelectedMerchandise extends AdMessageDetailsBase
    {
        public Double value = null;
        
        public Double getValue() { return value; }
        public AdMessageDetailsPercentageDiscountOnSelectedMerchandise setValue(Double value) { this.value = value; return this; }
    }

    public static class AdMessageDetailsAbsoluteDiscountOnSelectedMerchandise extends AdMessageDetailsBase
    {
        public Double value = null;
        
        public Double getValue() { return value; }
        public AdMessageDetailsAbsoluteDiscountOnSelectedMerchandise setValue(Double value) { this.value = value; return this; }
    }

    public static class AdMessageDetailsAbsoluteDiscountRangeOnAllMerchandise extends AdMessageDetailsBase
    {
        public Double start = null;
        public Double stop = null;
        
        public Double getStart() { return start; }
        public AdMessageDetailsAbsoluteDiscountRangeOnAllMerchandise setStart(Double value) { this.start = value; return this; }
        public Double getStop() { return stop; }
        public AdMessageDetailsAbsoluteDiscountRangeOnAllMerchandise setStop(Double value) { this.stop = value; return this; }
    }

    public static class AdMessageDetailsTotalAmountOverXgivesYdiscount extends AdMessageDetailsBase
    {
        public Double ifTotalAmountMoreThanX = null;
        public Double thenYouGetDiscountPercentageY = null;
        
        public Double getIfTotalAmountMoreThanX() { return ifTotalAmountMoreThanX; }
        public AdMessageDetailsTotalAmountOverXgivesYdiscount setIfTotalAmountMoreThanX(Double value) { this.ifTotalAmountMoreThanX = value; return this; }
        public Double getThenYouGetDiscountPercentageY() { return thenYouGetDiscountPercentageY; }
        public AdMessageDetailsTotalAmountOverXgivesYdiscount setThenYouGetDiscountPercentageY(Double value) { this.thenYouGetDiscountPercentageY = value; return this; }
    }

    public static class AdMessageDetailsXforYdiscount extends AdMessageDetailsBase
    {
        public Integer ifYouBuyX = null;
        public Integer thenYouGetY = null;
        
        public Integer getIfYouBuyX() { return ifYouBuyX; }
        public AdMessageDetailsXforYdiscount setIfYouBuyX(Integer value) { this.ifYouBuyX = value; return this; }
        public Integer getThenYouGetY() { return thenYouGetY; }
        public AdMessageDetailsXforYdiscount setThenYouGetY(Integer value) { this.thenYouGetY = value; return this; }
    }

    public static class AdMessageDetailsNewArrivals extends AdMessageDetailsBase
    {
        
    }

    public static class AdMessageDetailsFreetext extends AdMessageDetailsBase
    {
        public String title = null;
        
        public String getTitle() { return title; }
        public AdMessageDetailsFreetext setTitle(String value) { this.title = value; return this; }
    }

    public static class AdMessageDetailsTodaysBreakFastOffer extends AdMessageDetailsBase
    {
        public Double value = null;
        
        public Double getValue() { return value; }
        public AdMessageDetailsTodaysBreakFastOffer setValue(Double value) { this.value = value; return this; }
    }

    public static class AdMessageDetailsTodaysLunchOffer extends AdMessageDetailsBase
    {
        public Double value = null;
        
        public Double getValue() { return value; }
        public AdMessageDetailsTodaysLunchOffer setValue(Double value) { this.value = value; return this; }
    }

    public static class AdMessageDetailsTodaysDinnerOffer extends AdMessageDetailsBase
    {
        public Double value = null;
        
        public Double getValue() { return value; }
        public AdMessageDetailsTodaysDinnerOffer setValue(Double value) { this.value = value; return this; }
    }

    public static class AdMessageDetailsSaveFoodAndMoney extends AdMessageDetailsBase
    {
        public Double value = null;
        
        public Double getValue() { return value; }
        public AdMessageDetailsSaveFoodAndMoney setValue(Double value) { this.value = value; return this; }
    }

    public static class AdMessageDetailsPercentageOffYourFoodBill extends AdMessageDetailsBase
    {
        public Double percentage = null;
        
        public Double getPercentage() { return percentage; }
        public AdMessageDetailsPercentageOffYourFoodBill setPercentage(Double value) { this.percentage = value; return this; }
    }

    public static class AdMessageDetailsHappyHour extends AdMessageDetailsBase
    {
        
    }

    public static class AdMessageDetailsSomeFreeTablesLeftToday extends AdMessageDetailsBase
    {
        
    }

    public static class AdMessageDetailsTwoDishesForThePriceOfOne extends AdMessageDetailsBase
    {
        
    }

}

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

{
	adMessage: 
	{
		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
				]
			}
		}
	}
}