| POST | /share/share-ad-link-used | A share AD link was used | Validates the JWT token with the identity of the sharing user and the shared AD Message and returns relevant information. |
|---|
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 AdDto
Public Property Id As Long
Public Property Guid As Guid
Public Property Title As String
Public Property StartAt As DateTimeOffset
Public Property StopAt As DateTimeOffset
Public Property PublishAt As DateTimeOffset
Public Property ImageUrls As List(Of ImageUrls) = New List(Of ImageUrls)
Public Property Place As PlaceBasicApiDto
Public Property DetailsUnion As AdDetailsUnion
Public Property StarredCount As Long
End Class
Public Partial Class BrandApiDto
Public Property Name As String
End Class
Public Partial Class CategoryTreeApiDto
Public Property Name As String
Public Property Slug As String
Public Property AbsoluteSlug As String
Public Property ImageUrl As String
Public Property AllImageUrl As String
Public Property IconImageUrl As String
Public Property Position As Integer
Public Property Children As List(Of CategoryTreeApiDto) = New List(Of CategoryTreeApiDto)
End Class
Public Partial Class PlaceBasicApiDto
Public Property Id As Long
Public Property Guid As Guid
Public Property Overview As String
Public Property Name As String
Public Property Longitude As Single
Public Property Latitude As Single
Public Property Claimed As Boolean
Public Property OrganizationNumber As String
Public Property CountryCode As String
Public Property OpeningHours As OpeningHours
Public Property WheelchairAccessible As Boolean?
Public Property Wifi As Boolean?
Public Property OutdoorSeating As Boolean?
Public Property SaveFoodAndMoney As Boolean?
Public Property PlaceType As PlaceType
Public Property PriceMainDish As PriceMainDishApiDto
Public Property TimeZoneDto As TimeZoneDto
Public Property BusinessId As Long?
Public Property Contact As PlaceContact
Public Property Address As PlaceAddress
Public Property Categories As List(Of CategoryTreeApiDto) = New List(Of CategoryTreeApiDto)
Public Property LogoUrl As ImageUrls
Public Property ImageUrl As ImageUrls
Public Property WearPriceProfiles As List(Of WearPriceProfileEsDto) = New List(Of WearPriceProfileEsDto)
Public Property Brands As List(Of PlaceSelectedBrandApiDto) = New List(Of PlaceSelectedBrandApiDto)
Public Property Floor As String
End Class
Public Partial Class PlaceCustomBrandApiDto
Public Property Name As String
End Class
Public Partial Class PlaceSelectedBrandApiDto
Public Property Brand As BrandApiDto
Public Property CategoryAbsoluteSlugs As String() = New String(){}
Public Property PlaceCustomBrand As PlaceCustomBrandApiDto
End Class
Public Partial Class PriceMainDishApiDto
Public Property Title As String
Public Property Slug As PriceMainDish
End Class
Public Partial Class ShareAdLinkUsedRequest
Implements IPost
Public Property ShareAdToken As String
Public Property Locale As Locale?
End Class
Public Partial Class ShareAdLinkUsedResponse
Public Property User As SharingUser
Public Property Ad As AdDto
Public Property Place As PlaceBasicApiDto
Public Property State As SharingState
End Class
Public Enum SharingState
Teaser
Awarded
SelfShare
Expired
End Enum
Public Partial Class SharingUser
Public Property FirstName As String
Public Property LastName As String
Public Property ProfilePhotoUrl As String
End Class
Public Partial Class WearPriceProfileEsDto
Public Property Slug As String
Public Property Label As String
End Class
Public Partial Class AdDetailsAbsoluteDiscountOnSelectedMerchandise
Inherits AdDetailsBase
Public Property Value As Double
End Class
Public Partial Class AdDetailsAbsoluteDiscountRangeOnAllMerchandise
Inherits AdDetailsBase
Public Property Start As Double
Public Property [Stop] As Double
End Class
Public Partial Class AdDetailsBase
Public Property Description As String
Public Property MoreInformation As List(Of String) = New List(Of String)
End Class
Public Partial Class AdDetailsFreetext
Inherits AdDetailsBase
Public Property Title As String
End Class
Public Partial Class AdDetailsHappyHour
Inherits AdDetailsBase
End Class
Public Partial Class AdDetailsNewArrivals
Inherits AdDetailsBase
End Class
Public Partial Class AdDetailsPercentageDiscountOnAllMerchandise
Inherits AdDetailsBase
Public Property Value As Double
End Class
Public Partial Class AdDetailsPercentageDiscountOnSelectedMerchandise
Inherits AdDetailsBase
Public Property Value As Double
End Class
Public Partial Class AdDetailsPercentageDiscountRangeOnAllMerchandise
Inherits AdDetailsBase
Public Property Start As Double
Public Property [Stop] As Double
End Class
Public Partial Class AdDetailsPercentageOffYourFoodBill
Inherits AdDetailsBase
Public Property Percentage As Double
End Class
Public Partial Class AdDetailsSaveFoodAndMoney
Inherits AdDetailsBase
Public Property Value As Double
End Class
Public Partial Class AdDetailsSomeFreeTablesLeftToday
Inherits AdDetailsBase
End Class
Public Partial Class AdDetailsTodaysBreakFastOffer
Inherits AdDetailsBase
Public Property Value As Double
End Class
Public Partial Class AdDetailsTodaysDinnerOffer
Inherits AdDetailsBase
Public Property Value As Double
End Class
Public Partial Class AdDetailsTodaysLunchOffer
Inherits AdDetailsBase
Public Property Value As Double
End Class
Public Partial Class AdDetailsTotalAmountOverXgivesYdiscount
Inherits AdDetailsBase
Public Property IfTotalAmountMoreThanX As Double
Public Property ThenYouGetDiscountPercentageY As Double
End Class
Public Partial Class AdDetailsTwoDishesForThePriceOfOne
Inherits AdDetailsBase
End Class
Public Partial Class AdDetailsUnion
Public Property PercentageOnAllMerchandise As AdDetailsPercentageDiscountOnAllMerchandise
Public Property PercentageRangeOnAllMerchandise As AdDetailsPercentageDiscountRangeOnAllMerchandise
Public Property PercentageOnSelectedMerchandise As AdDetailsPercentageDiscountOnSelectedMerchandise
Public Property AbsoluteOnSelectedMerchandise As AdDetailsAbsoluteDiscountOnSelectedMerchandise
Public Property AbsoluteRangeOnAllMerchandise As AdDetailsAbsoluteDiscountRangeOnAllMerchandise
Public Property TotalAmountOverXgivesYdiscount As AdDetailsTotalAmountOverXgivesYdiscount
Public Property XforY As AdDetailsXforYdiscount
Public Property NewArrivals As AdDetailsNewArrivals
Public Property Freetext As AdDetailsFreetext
Public Property TodaysBreakFastOffer As AdDetailsTodaysBreakFastOffer
Public Property TodaysLunchOffer As AdDetailsTodaysLunchOffer
Public Property TodaysDinnerOffer As AdDetailsTodaysDinnerOffer
Public Property SaveFoodAndMoney As AdDetailsSaveFoodAndMoney
Public Property PercentageOfYourFoodBill As AdDetailsPercentageOffYourFoodBill
Public Property HappyHour As AdDetailsHappyHour
Public Property SomeFreeTablesLeftToday As AdDetailsSomeFreeTablesLeftToday
Public Property TwoDishesForThePriceOfOne As AdDetailsTwoDishesForThePriceOfOne
End Class
Public Partial Class AdDetailsXforYdiscount
Inherits AdDetailsBase
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 Enum Locale
EnUs
NbNo
End Enum
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 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 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 ShareAdLinkUsedRequest DTOs
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.
POST /share/share-ad-link-used HTTP/1.1
Host: qa-business-api.brovs.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
shareAdToken: String,
locale: EnUs
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
user:
{
firstName: String,
lastName: String,
profilePhotoUrl: String
},
ad:
{
id: 0,
title: String,
startAt: 0001-01-01T00:00:00.0000000+00:00,
stopAt: 0001-01-01T00:00:00.0000000+00:00,
publishAt: 0001-01-01T00:00:00.0000000+00:00,
imageUrls:
[
{
preview: String,
small: String,
medium: String,
large: String
}
],
place:
{
id: 0,
overview: String,
name: String,
longitude: 0,
latitude: 0,
claimed: False,
organizationNumber: String,
countryCode: 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
}
}
},
wheelchairAccessible: False,
wifi: False,
outdoorSeating: False,
saveFoodAndMoney: False,
placeType: Mall,
priceMainDish:
{
title: String,
slug: Value
},
timeZoneDto:
{
baseUtcOffset: PT0S,
daylightName: String,
displayName: String,
id: String,
standardName: String,
supportsDaylightSavingTime: False
},
businessId: 0,
contact:
{
phone: String,
email: String,
website: String,
webShop: String
},
address:
{
street: String,
postalCode: String,
region: String,
countryCode: String
},
categories:
[
{
name: String,
slug: String,
absoluteSlug: String,
imageUrl: String,
allImageUrl: String,
iconImageUrl: String,
position: 0,
children:
[
{
name: String,
slug: String,
absoluteSlug: String,
imageUrl: String,
allImageUrl: String,
iconImageUrl: String,
position: 0,
children:
[
{
name: String,
slug: String,
absoluteSlug: String,
imageUrl: String,
allImageUrl: String,
iconImageUrl: String,
position: 0
}
]
}
]
}
],
logoUrl:
{
preview: String,
small: String,
medium: String,
large: String
},
imageUrl:
{
preview: String,
small: String,
medium: String,
large: String
},
wearPriceProfiles:
[
{
slug: String,
label: String
}
],
brands:
[
{
brand:
{
name: String
},
categoryAbsoluteSlugs:
[
String
],
placeCustomBrand:
{
name: 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
]
}
},
starredCount: 0
},
place:
{
id: 0,
overview: String,
name: String,
longitude: 0,
latitude: 0,
claimed: False,
organizationNumber: String,
countryCode: 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
}
}
},
wheelchairAccessible: False,
wifi: False,
outdoorSeating: False,
saveFoodAndMoney: False,
placeType: Mall,
priceMainDish:
{
title: String,
slug: Value
},
timeZoneDto:
{
baseUtcOffset: PT0S,
daylightName: String,
displayName: String,
id: String,
standardName: String,
supportsDaylightSavingTime: False
},
businessId: 0,
contact:
{
phone: String,
email: String,
website: String,
webShop: String
},
address:
{
street: String,
postalCode: String,
region: String,
countryCode: String
},
categories:
[
{
name: String,
slug: String,
absoluteSlug: String,
imageUrl: String,
allImageUrl: String,
iconImageUrl: String,
position: 0,
children:
[
{
name: String,
slug: String,
absoluteSlug: String,
imageUrl: String,
allImageUrl: String,
iconImageUrl: String,
position: 0,
children:
[
{
name: String,
slug: String,
absoluteSlug: String,
imageUrl: String,
allImageUrl: String,
iconImageUrl: String,
position: 0
}
]
}
]
}
],
logoUrl:
{
preview: String,
small: String,
medium: String,
large: String
},
imageUrl:
{
preview: String,
small: String,
medium: String,
large: String
},
wearPriceProfiles:
[
{
slug: String,
label: String
}
],
brands:
[
{
brand:
{
name: String
},
categoryAbsoluteSlugs:
[
String
],
placeCustomBrand:
{
name: String
}
}
],
floor: String
},
state: Teaser
}