ConsumerApi

<back to all web services

ShareAdMessageLinkUsedRequest

Consumer
The following routes are available for this service:
POST/share/share-ad-message-link-usedA share AD Message link was usedValidates the JWT token with the identity of the sharing user and the shared AD Message and returns relevant information.
ShareAdMessageLinkUsedRequest Parameters:
NameParameterData TypeRequiredDescription
ShareAdMessageTokenbodystringYes
LocalebodyLocale?No
Locale Enum:
EnUs
NbNo
ShareAdMessageLinkUsedResponse Parameters:
NameParameterData TypeRequiredDescription
UserformSharingUserNo
AdMessageformSharedAdMessageNo
PlaceformSharedPlaceNo
ExpiresAtformDateTimeOffset?No
StateformSharingStateNo
SharingUser Parameters:
NameParameterData TypeRequiredDescription
FirstNameformstringYes
LastNameformstringYes
ProfilePhotoUrlformstringNo
SharedAdMessage Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
GuidformGuidNo
TitleformstringYes
ImageUrlformstringNo
StartAtformDateTimeOffsetNo
StopAtformDateTimeOffsetNo
SharedPlace Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
GuidformGuidNo
NameformstringYes
LogoUrlformstringNo
ImageUrlformstringNo
OpeningHoursformOpeningHoursNo
TimeZoneDtoformTimeZoneDtoYes
RootCategoriesformList<SharedRootCategory>Yes
PriceMainDishformSharePriceMainDishNo
WearPriceProfilesformList<ShareWearPriceProfile>Yes
OpeningHours Parameters:
NameParameterData TypeRequiredDescription
WeeklyformWeeklyOpeningHoursYes
WeeklyOpeningHours Parameters:
NameParameterData TypeRequiredDescription
MondayformOpeningHourNo
TuesdayformOpeningHourNo
WednesdayformOpeningHourNo
ThursdayformOpeningHourNo
FridayformOpeningHourNo
SaturdayformOpeningHourNo
SundayformOpeningHourNo
OpeningHour Parameters:
NameParameterData TypeRequiredDescription
OpenAtHourformintNo
OpenAtMinuteformintNo
CloseAtHourformintNo
CloseAtMinuteformintNo
TimeZoneDto Parameters:
NameParameterData TypeRequiredDescription
BaseUtcOffsetformTimeSpanNo
DaylightNameformstringYes
DisplayNameformstringYes
IdformstringYes
StandardNameformstringYes
SupportsDaylightSavingTimeformboolNo
SharedRootCategory Parameters:
NameParameterData TypeRequiredDescription
NameformstringYes
AbsoluteSlugformstringYes
SharePriceMainDish Parameters:
NameParameterData TypeRequiredDescription
LabelformstringYes
SlugformPriceMainDishNo
PriceMainDish Enum:
Value
Medium
High
FineDining
ShareWearPriceProfile Parameters:
NameParameterData TypeRequiredDescription
LabelformstringYes
SlugformstringYes
SharingState Enum:
Teaser
Awarded
SelfShare
Expired

To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other

HTTP + OTHER

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/jsonl
Content-Type: text/jsonl
Content-Length: length

{"shareAdMessageToken":"String","locale":"EnUs"}
HTTP/1.1 200 OK
Content-Type: text/jsonl
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"}