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
namespace BusinessApi

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    type VisibilityState =
        | Draft = 0
        | Running = 1
        | Upcoming = 2
        | Archived = 3
        | Paused = 4

    [<AllowNullLiteral>]
    type ImageUrls() = 
        member val Preview:String = null with get,set
        member val Small:String = null with get,set
        member val Medium:String = null with get,set
        member val Large:String = null with get,set

    [<AllowNullLiteral>]
    type OpeningHour() = 
        member val OpenAtHour:Int32 = new Int32() with get,set
        member val OpenAtMinute:Int32 = new Int32() with get,set
        member val CloseAtHour:Int32 = new Int32() with get,set
        member val CloseAtMinute:Int32 = new Int32() with get,set

    [<AllowNullLiteral>]
    type WeeklyOpeningHours() = 
        member val Monday:OpeningHour = null with get,set
        member val Tuesday:OpeningHour = null with get,set
        member val Wednesday:OpeningHour = null with get,set
        member val Thursday:OpeningHour = null with get,set
        member val Friday:OpeningHour = null with get,set
        member val Saturday:OpeningHour = null with get,set
        member val Sunday:OpeningHour = null with get,set

    [<AllowNullLiteral>]
    type OpeningHours() = 
        member val Weekly:WeeklyOpeningHours = null with get,set

    type PlaceType =
        | Mall = 0
        | Regular = 1

    [<AllowNullLiteral>]
    type PlaceContact() = 
        member val Phone:String = null with get,set
        member val Email:String = null with get,set
        member val Website:String = null with get,set
        member val WebShop:String = null with get,set

    [<AllowNullLiteral>]
    type PlaceAddress() = 
        member val Street:String = null with get,set
        member val PostalCode:String = null with get,set
        member val Region:String = null with get,set
        member val CountryCode:String = null with get,set

    [<AllowNullLiteral>]
    type TimeZoneDto() = 
        member val BaseUtcOffset:TimeSpan = new TimeSpan() with get,set
        member val DaylightName:String = null with get,set
        member val DisplayName:String = null with get,set
        member val Id:String = null with get,set
        member val StandardName:String = null with get,set
        member val SupportsDaylightSavingTime:Boolean = new Boolean() with get,set

    type PriceMainDish =
        | Value = 0
        | Medium = 1
        | High = 2
        | FineDining = 3

    [<AllowNullLiteral>]
    type PriceMainDishDto() = 
        member val Title:String = null with get,set
        member val Slug:PriceMainDish = new PriceMainDish() with get,set

    [<AllowNullLiteral>]
    type AdMessageDetailsBase() = 
        member val Description:String = null with get,set
        member val MoreInformation:ResizeArray<String> = new ResizeArray<String>() with get,set

    [<AllowNullLiteral>]
    type AdMessageDetailsPercentageDiscountOnAllMerchandise() = 
        inherit AdMessageDetailsBase()
        member val Value:Double = new Double() with get,set

    [<AllowNullLiteral>]
    type AdMessageDetailsPercentageDiscountRangeOnAllMerchandise() = 
        inherit AdMessageDetailsBase()
        member val Start:Double = new Double() with get,set
        member val Stop:Double = new Double() with get,set

    [<AllowNullLiteral>]
    type AdMessageDetailsPercentageDiscountOnSelectedMerchandise() = 
        inherit AdMessageDetailsBase()
        member val Value:Double = new Double() with get,set

    [<AllowNullLiteral>]
    type AdMessageDetailsAbsoluteDiscountOnSelectedMerchandise() = 
        inherit AdMessageDetailsBase()
        member val Value:Double = new Double() with get,set

    [<AllowNullLiteral>]
    type AdMessageDetailsAbsoluteDiscountRangeOnAllMerchandise() = 
        inherit AdMessageDetailsBase()
        member val Start:Double = new Double() with get,set
        member val Stop:Double = new Double() with get,set

    [<AllowNullLiteral>]
    type AdMessageDetailsTotalAmountOverXgivesYdiscount() = 
        inherit AdMessageDetailsBase()
        member val IfTotalAmountMoreThanX:Double = new Double() with get,set
        member val ThenYouGetDiscountPercentageY:Double = new Double() with get,set

    [<AllowNullLiteral>]
    type AdMessageDetailsXforYdiscount() = 
        inherit AdMessageDetailsBase()
        member val IfYouBuyX:Int32 = new Int32() with get,set
        member val ThenYouGetY:Int32 = new Int32() with get,set

    [<AllowNullLiteral>]
    type AdMessageDetailsNewArrivals() = 
        inherit AdMessageDetailsBase()

    [<AllowNullLiteral>]
    type AdMessageDetailsFreetext() = 
        inherit AdMessageDetailsBase()
        member val Title:String = null with get,set

    [<AllowNullLiteral>]
    type AdMessageDetailsTodaysBreakFastOffer() = 
        inherit AdMessageDetailsBase()
        member val Value:Double = new Double() with get,set

    [<AllowNullLiteral>]
    type AdMessageDetailsTodaysLunchOffer() = 
        inherit AdMessageDetailsBase()
        member val Value:Double = new Double() with get,set

    [<AllowNullLiteral>]
    type AdMessageDetailsTodaysDinnerOffer() = 
        inherit AdMessageDetailsBase()
        member val Value:Double = new Double() with get,set

    [<AllowNullLiteral>]
    type AdMessageDetailsSaveFoodAndMoney() = 
        inherit AdMessageDetailsBase()
        member val Value:Double = new Double() with get,set

    [<AllowNullLiteral>]
    type AdMessageDetailsPercentageOffYourFoodBill() = 
        inherit AdMessageDetailsBase()
        member val Percentage:Double = new Double() with get,set

    [<AllowNullLiteral>]
    type AdMessageDetailsHappyHour() = 
        inherit AdMessageDetailsBase()

    [<AllowNullLiteral>]
    type AdMessageDetailsSomeFreeTablesLeftToday() = 
        inherit AdMessageDetailsBase()

    [<AllowNullLiteral>]
    type AdMessageDetailsTwoDishesForThePriceOfOne() = 
        inherit AdMessageDetailsBase()

    [<AllowNullLiteral>]
    type AdMessageDetailsUnion() = 
        member val PercentageOnAllMerchandise:AdMessageDetailsPercentageDiscountOnAllMerchandise = null with get,set
        member val PercentageRangeOnAllMerchandise:AdMessageDetailsPercentageDiscountRangeOnAllMerchandise = null with get,set
        member val PercentageOnSelectedMerchandise:AdMessageDetailsPercentageDiscountOnSelectedMerchandise = null with get,set
        member val AbsoluteOnSelectedMerchandise:AdMessageDetailsAbsoluteDiscountOnSelectedMerchandise = null with get,set
        member val AbsoluteRangeOnAllMerchandise:AdMessageDetailsAbsoluteDiscountRangeOnAllMerchandise = null with get,set
        member val TotalAmountOverXgivesYdiscount:AdMessageDetailsTotalAmountOverXgivesYdiscount = null with get,set
        member val XforY:AdMessageDetailsXforYdiscount = null with get,set
        member val NewArrivals:AdMessageDetailsNewArrivals = null with get,set
        member val Freetext:AdMessageDetailsFreetext = null with get,set
        member val TodaysBreakFastOffer:AdMessageDetailsTodaysBreakFastOffer = null with get,set
        member val TodaysLunchOffer:AdMessageDetailsTodaysLunchOffer = null with get,set
        member val TodaysDinnerOffer:AdMessageDetailsTodaysDinnerOffer = null with get,set
        member val SaveFoodAndMoney:AdMessageDetailsSaveFoodAndMoney = null with get,set
        member val PercentageOfYourFoodBill:AdMessageDetailsPercentageOffYourFoodBill = null with get,set
        member val HappyHour:AdMessageDetailsHappyHour = null with get,set
        member val SomeFreeTablesLeftToday:AdMessageDetailsSomeFreeTablesLeftToday = null with get,set
        member val TwoDishesForThePriceOfOne:AdMessageDetailsTwoDishesForThePriceOfOne = null with get,set

F# 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
					]
				}
			}
		}
	]
}