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
Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports BusinessApi

Namespace Global

    Namespace BusinessApi

        Public Partial Class AdMessageDetailsAbsoluteDiscountOnSelectedMerchandise
            Inherits AdMessageDetailsBase
            Public Property Value As Double
        End Class

        Public Partial Class AdMessageDetailsAbsoluteDiscountRangeOnAllMerchandise
            Inherits AdMessageDetailsBase
            Public Property Start As Double
            Public Property [Stop] As Double
        End Class

        Public Partial Class AdMessageDetailsBase
            Public Property Description As String
            Public Property MoreInformation As List(Of String) = New List(Of String)
        End Class

        Public Partial Class AdMessageDetailsFreetext
            Inherits AdMessageDetailsBase
            Public Property Title As String
        End Class

        Public Partial Class AdMessageDetailsHappyHour
            Inherits AdMessageDetailsBase
        End Class

        Public Partial Class AdMessageDetailsNewArrivals
            Inherits AdMessageDetailsBase
        End Class

        Public Partial Class AdMessageDetailsPercentageDiscountOnAllMerchandise
            Inherits AdMessageDetailsBase
            Public Property Value As Double
        End Class

        Public Partial Class AdMessageDetailsPercentageDiscountOnSelectedMerchandise
            Inherits AdMessageDetailsBase
            Public Property Value As Double
        End Class

        Public Partial Class AdMessageDetailsPercentageDiscountRangeOnAllMerchandise
            Inherits AdMessageDetailsBase
            Public Property Start As Double
            Public Property [Stop] As Double
        End Class

        Public Partial Class AdMessageDetailsPercentageOffYourFoodBill
            Inherits AdMessageDetailsBase
            Public Property Percentage As Double
        End Class

        Public Partial Class AdMessageDetailsSaveFoodAndMoney
            Inherits AdMessageDetailsBase
            Public Property Value As Double
        End Class

        Public Partial Class AdMessageDetailsSomeFreeTablesLeftToday
            Inherits AdMessageDetailsBase
        End Class

        Public Partial Class AdMessageDetailsTodaysBreakFastOffer
            Inherits AdMessageDetailsBase
            Public Property Value As Double
        End Class

        Public Partial Class AdMessageDetailsTodaysDinnerOffer
            Inherits AdMessageDetailsBase
            Public Property Value As Double
        End Class

        Public Partial Class AdMessageDetailsTodaysLunchOffer
            Inherits AdMessageDetailsBase
            Public Property Value As Double
        End Class

        Public Partial Class AdMessageDetailsTotalAmountOverXgivesYdiscount
            Inherits AdMessageDetailsBase
            Public Property IfTotalAmountMoreThanX As Double
            Public Property ThenYouGetDiscountPercentageY As Double
        End Class

        Public Partial Class AdMessageDetailsTwoDishesForThePriceOfOne
            Inherits AdMessageDetailsBase
        End Class

        Public Partial Class AdMessageDetailsUnion
            Public Property PercentageOnAllMerchandise As AdMessageDetailsPercentageDiscountOnAllMerchandise
            Public Property PercentageRangeOnAllMerchandise As AdMessageDetailsPercentageDiscountRangeOnAllMerchandise
            Public Property PercentageOnSelectedMerchandise As AdMessageDetailsPercentageDiscountOnSelectedMerchandise
            Public Property AbsoluteOnSelectedMerchandise As AdMessageDetailsAbsoluteDiscountOnSelectedMerchandise
            Public Property AbsoluteRangeOnAllMerchandise As AdMessageDetailsAbsoluteDiscountRangeOnAllMerchandise
            Public Property TotalAmountOverXgivesYdiscount As AdMessageDetailsTotalAmountOverXgivesYdiscount
            Public Property XforY As AdMessageDetailsXforYdiscount
            Public Property NewArrivals As AdMessageDetailsNewArrivals
            Public Property Freetext As AdMessageDetailsFreetext
            Public Property TodaysBreakFastOffer As AdMessageDetailsTodaysBreakFastOffer
            Public Property TodaysLunchOffer As AdMessageDetailsTodaysLunchOffer
            Public Property TodaysDinnerOffer As AdMessageDetailsTodaysDinnerOffer
            Public Property SaveFoodAndMoney As AdMessageDetailsSaveFoodAndMoney
            Public Property PercentageOfYourFoodBill As AdMessageDetailsPercentageOffYourFoodBill
            Public Property HappyHour As AdMessageDetailsHappyHour
            Public Property SomeFreeTablesLeftToday As AdMessageDetailsSomeFreeTablesLeftToday
            Public Property TwoDishesForThePriceOfOne As AdMessageDetailsTwoDishesForThePriceOfOne
        End Class

        Public Partial Class AdMessageDetailsXforYdiscount
            Inherits AdMessageDetailsBase
            Public Property IfYouBuyX As Integer
            Public Property ThenYouGetY As Integer
        End Class

        Public Partial Class ImageUrls
            Public Property Preview As String
            Public Property Small As String
            Public Property Medium As String
            Public Property Large As String
        End Class

        Public Partial Class OpeningHour
            Public Property OpenAtHour As Integer
            Public Property OpenAtMinute As Integer
            Public Property CloseAtHour As Integer
            Public Property CloseAtMinute As Integer
        End Class

        Public Partial Class OpeningHours
            Public Property Weekly As WeeklyOpeningHours
        End Class

        Public Partial Class PlaceAddress
            Public Property Street As String
            Public Property PostalCode As String
            Public Property Region As String
            Public Property CountryCode As String
        End Class

        Public Partial Class PlaceContact
            Public Property Phone As String
            Public Property Email As String
            Public Property Website As String
            Public Property WebShop As String
        End Class

        Public Enum PlaceType
            Mall
            Regular
        End Enum

        Public Partial Class PriceMainDishDto
            Public Property Title As String
            Public Property Slug As PriceMainDish
        End Class

        Public Partial Class TimeZoneDto
            Public Property BaseUtcOffset As TimeSpan
            Public Property DaylightName As String
            Public Property DisplayName As String
            Public Property Id As String
            Public Property StandardName As String
            Public Property SupportsDaylightSavingTime As Boolean
        End Class

        Public Enum VisibilityState
            Draft
            Running
            Upcoming
            Archived
            Paused
        End Enum

        Public Partial Class WeeklyOpeningHours
            Public Property Monday As OpeningHour
            Public Property Tuesday As OpeningHour
            Public Property Wednesday As OpeningHour
            Public Property Thursday As OpeningHour
            Public Property Friday As OpeningHour
            Public Property Saturday As OpeningHour
            Public Property Sunday As OpeningHour
        End Class

        Public Enum PriceMainDish
            Value
            Medium
            High
            FineDining
        End Enum
    End Namespace
End Namespace

VB.NET 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
					]
				}
			}
		}
	]
}