| Required role: | Business |
| POST | /admessage/create |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| PlaceId | body | long | No | |
| DetailsUnion | body | AdMessageDetailsUnion | Yes |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| PercentageOnAllMerchandise | form | AdMessageDetailsPercentageDiscountOnAllMerchandise | No | |
| PercentageRangeOnAllMerchandise | form | AdMessageDetailsPercentageDiscountRangeOnAllMerchandise | No | |
| PercentageOnSelectedMerchandise | form | AdMessageDetailsPercentageDiscountOnSelectedMerchandise | No | |
| AbsoluteOnSelectedMerchandise | form | AdMessageDetailsAbsoluteDiscountOnSelectedMerchandise | No | |
| AbsoluteRangeOnAllMerchandise | form | AdMessageDetailsAbsoluteDiscountRangeOnAllMerchandise | No | |
| TotalAmountOverXgivesYdiscount | form | AdMessageDetailsTotalAmountOverXgivesYdiscount | No | |
| XforY | form | AdMessageDetailsXforYdiscount | No | |
| NewArrivals | form | AdMessageDetailsNewArrivals | No | |
| Freetext | form | AdMessageDetailsFreetext | No | |
| TodaysBreakFastOffer | form | AdMessageDetailsTodaysBreakFastOffer | No | |
| TodaysLunchOffer | form | AdMessageDetailsTodaysLunchOffer | No | |
| TodaysDinnerOffer | form | AdMessageDetailsTodaysDinnerOffer | No | |
| SaveFoodAndMoney | form | AdMessageDetailsSaveFoodAndMoney | No | |
| PercentageOfYourFoodBill | form | AdMessageDetailsPercentageOffYourFoodBill | No | |
| HappyHour | form | AdMessageDetailsHappyHour | No | |
| SomeFreeTablesLeftToday | form | AdMessageDetailsSomeFreeTablesLeftToday | No | |
| TwoDishesForThePriceOfOne | form | AdMessageDetailsTwoDishesForThePriceOfOne | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Value | form | double | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Description | form | string | No | |
| MoreInformation | form | List<string> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Start | form | double | No | |
| Stop | form | double | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Value | form | double | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Value | form | double | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Start | form | double | No | |
| Stop | form | double | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| IfTotalAmountMoreThanX | form | double | No | |
| ThenYouGetDiscountPercentageY | form | double | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| IfYouBuyX | form | int | No | |
| ThenYouGetY | form | int | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Title | form | string | Yes |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Value | form | double | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Value | form | double | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Value | form | double | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Value | form | double | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Percentage | form | double | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | long | No | |
| Guid | form | Guid | No |
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 /admessage/create HTTP/1.1
Host: business-api.brovs.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
placeId: 0,
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
]
}
}
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
id: 0
}