| All Verbs | /service/QueryPromotions |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Search | query | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Skip | form | int? | No | |
| Take | form | int? | No | |
| OrderBy | form | string | No | |
| OrderByDesc | form | string | No | |
| Include | form | string | No | |
| Fields | form | string | No | |
| Meta | form | Dictionary<string, string> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | string | No | |
| Description | form | string | No | |
| StartOn | form | DateTime | No | |
| EndOn | form | DateTime | No | |
| ShipBefore | form | DateTime | No | |
| ShipAfter | form | DateTime | No | |
| Type | form | string | No | |
| BrandId | form | string | No | |
| RewardType | form | string | No | |
| DisplayOnCheckout | form | bool | No | |
| ApplyWholeOrder | form | bool | No | |
| OneTimeUse | form | bool | No | |
| Status | form | string | No | |
| CreatedBy | form | string | No | |
| QualifyAmount | form | double? | No | |
| MaxQualifyAmount | form | double? | No | |
| QualifyQuantity | form | int? | No | |
| ProductLineID | form | string | No | |
| Category | form | string | No | |
| SubCategory | form | string | No | |
| ProductID | form | string | No | |
| OrderSource | form | string | No | |
| GeneratedFrom | form | string | No | |
| AdvancedCriteria | form | string | No | |
| SpecialTerm | form | string | No | |
| Note | form | string | No | |
| DiscountPercent | form | double? | No | |
| PriceList | form | string | No | |
| DiscountDollar | form | double? | No | |
| FreeProduct | form | string | No | |
| Tags | form | Dictionary<string, HashSet<String>> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | K | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Offset | form | int | No | |
| Total | form | int | No | |
| Results | form | List<T> | No | |
| Meta | form | Dictionary<string, string> | No | |
| ResponseStatus | form | ResponseStatus | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /service/QueryPromotions HTTP/1.1
Host: www.bernhardthospitality.com
Accept: application/json
Content-Type: application/json
Content-Length: length
{"search":"String","skip":0,"take":0,"orderBy":"String","orderByDesc":"String","include":"String","fields":"String","meta":{"String":"String"}}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"offset":0,"total":0,"results":[{"id":"String","description":"String","startOn":"0001-01-01T00:00:00.0000000Z","endOn":"0001-01-01T00:00:00.0000000Z","shipBefore":"0001-01-01T00:00:00.0000000Z","shipAfter":"0001-01-01T00:00:00.0000000Z","type":"String","brandId":"String","rewardType":"String","displayOnCheckout":false,"applyWholeOrder":false,"oneTimeUse":false,"status":"String","createdBy":"String","qualifyAmount":0,"maxQualifyAmount":0,"qualifyQuantity":0,"productLineID":"String","category":"String","subCategory":"String","productID":"String","orderSource":"String","generatedFrom":"String","advancedCriteria":"String","specialTerm":"String","note":"String","discountPercent":0,"priceList":"String","discountDollar":0,"freeProduct":"String","tags":{"String":["String"]}}],"meta":{"String":"String"},"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}