ConsumerApi

ShareAdMessageLinkUsedRequest

Consumer

The following routes are available for this service:
POST	/share/share-ad-message-link-used	A share AD Message link was used	Validates the JWT token with the identity of the sharing user and the shared AD Message and returns relevant information.

**ShareAdMessageLinkUsedRequest** Parameters:
Name	Parameter	Data Type	Required	Description
ShareAdMessageToken	body	string	Yes
Locale	body	Locale?	No

**Locale** Enum:
EnUs
NbNo

**ShareAdMessageLinkUsedResponse** Parameters:
Name	Parameter	Data Type	Required
User	form	SharingUser	No
AdMessage	form	SharedAdMessage	No
Place	form	SharedPlace	No
ExpiresAt	form	DateTimeOffset?	No
State	form	SharingState	No

**SharingUser** Parameters:
Name	Parameter	Data Type	Required
FirstName	form	string	Yes
LastName	form	string	Yes
ProfilePhotoUrl	form	string	No

**SharedAdMessage** Parameters:
Name	Parameter	Data Type	Required
Id	form	long	No
Guid	form	Guid	No
Title	form	string	Yes
ImageUrl	form	string	No
StartAt	form	DateTimeOffset	No
StopAt	form	DateTimeOffset	No

**SharedPlace** Parameters:
Name	Parameter	Data Type	Required
Id	form	long	No
Guid	form	Guid	No
Name	form	string	Yes
LogoUrl	form	string	No
ImageUrl	form	string	No
OpeningHours	form	OpeningHours	No
TimeZoneDto	form	TimeZoneDto	Yes
RootCategories	form	List<SharedRootCategory>	Yes
PriceMainDish	form	SharePriceMainDish	No
WearPriceProfiles	form	List<ShareWearPriceProfile>	Yes

**OpeningHours** Parameters:
Name	Parameter	Data Type	Required	Description
Weekly	form	WeeklyOpeningHours	Yes

**WeeklyOpeningHours** Parameters:
Name	Parameter	Data Type	Required
Monday	form	OpeningHour	No
Tuesday	form	OpeningHour	No
Wednesday	form	OpeningHour	No
Thursday	form	OpeningHour	No
Friday	form	OpeningHour	No
Saturday	form	OpeningHour	No
Sunday	form	OpeningHour	No

**OpeningHour** Parameters:
Name	Parameter	Data Type	Required
OpenAtHour	form	int	No
OpenAtMinute	form	int	No
CloseAtHour	form	int	No
CloseAtMinute	form	int	No

**TimeZoneDto** Parameters:
Name	Parameter	Data Type	Required
BaseUtcOffset	form	TimeSpan	No
DaylightName	form	string	Yes
DisplayName	form	string	Yes
Id	form	string	Yes
StandardName	form	string	Yes
SupportsDaylightSavingTime	form	bool	No

**SharedRootCategory** Parameters:
Name	Parameter	Data Type	Required	Description
Name	form	string	Yes
AbsoluteSlug	form	string	Yes

**SharePriceMainDish** Parameters:
Name	Parameter	Data Type	Required	Description
Label	form	string	Yes
Slug	form	PriceMainDish	No

**PriceMainDish** Enum:
Value
Medium
High
FineDining

**ShareWearPriceProfile** Parameters:
Name	Parameter	Data Type	Required	Description
Label	form	string	Yes
Slug	form	string	Yes

**SharingState** Enum:
Teaser
Awarded
SelfShare
Expired

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.

POST /share/share-ad-message-link-used HTTP/1.1 
Host: consumer-api.brovs.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	shareAdMessageToken: String,
	locale: EnUs
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	user: 
	{
		firstName: String,
		lastName: String,
		profilePhotoUrl: String
	},
	adMessage: 
	{
		id: 0,
		title: String,
		imageUrl: String,
		startAt: 0001-01-01T00:00:00.0000000+00:00,
		stopAt: 0001-01-01T00:00:00.0000000+00:00
	},
	place: 
	{
		id: 0,
		name: String,
		logoUrl: String,
		imageUrl: 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
				}
			}
		},
		timeZoneDto: 
		{
			baseUtcOffset: PT0S,
			daylightName: String,
			displayName: String,
			id: String,
			standardName: String,
			supportsDaylightSavingTime: False
		},
		rootCategories: 
		[
			{
				name: String,
				absoluteSlug: String
			}
		],
		priceMainDish: 
		{
			label: String,
			slug: Value
		},
		wearPriceProfiles: 
		[
			{
				label: String,
				slug: String
			}
		]
	},
	expiresAt: 0001-01-01T00:00:00.0000000+00:00,
	state: Teaser
}