| GET | /api/SaleInfo |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| LocationId | query | long? | No | |
| DateTime | query | DateTime? | No | If sent, only sales that are active during the sent Date/Time are returned. Otherwise, the current Date/Time is used |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Token | Header | string | No | |
| DeviceId | Header | string | No | |
| AppId | Header | string | Yes |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ApiKey | header | string | Yes | This is your AIM API Key provided by Tri-Tech |
| OAuthToken | header | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| SaleRecords | form | List<SaleRecord> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Status | body | BaseResponseResult | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| StatusCode | body | string | No | |
| Login | body | string | No | |
| ErrorCode | body | string | No | |
| ErrorDisplayText | body | string | No | |
| ErrorMessage | body | string | No | |
| DomainName | body | string | No | |
| IpAddress | body | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| SadPk | form | long | No | |
| SkuPk | form | long | No | |
| SaqPk | form | long | No | |
| Model | form | string | No | |
| SKU | form | string | No | |
| LocationId | form | long | No | |
| StartDate | form | DateTime | No | |
| EndDate | form | DateTime | No | |
| CustomerAccount | form | int? | No | |
| CustomerDefaultId | form | long? | No | |
| Condition | form | string | No | |
| DiscountFromPriceLevel | form | DiscountFromPriceLevel | No | |
| DiscountByPriceLevel | form | string | No | |
| DiscountBySetPrice | form | decimal? | No | |
| DiscountByAmount | form | decimal? | No | |
| RecurringSale | form | RecurringSaleInfo | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| BasePriceLevel | form | string | No | |
| DisountPercentage | form | decimal | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Days | form | List<RecurringSaleDay> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Weekday | form | string | No | |
| BeginHour | form | int | No | |
| BeginMinute | form | int | No | |
| EndHour | form | int | No | |
| EndMinute | form | int | 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.
GET /api/SaleInfo HTTP/1.1 Host: active-ewebservice.biz Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"SaleRecords":[{"SadPk":0,"SkuPk":0,"SaqPk":0,"Model":"String","SKU":"String","LocationId":0,"CustomerAccount":0,"CustomerDefaultId":0,"Condition":"String","DiscountFromPriceLevel":{"BasePriceLevel":"String","DisountPercentage":0},"DiscountByPriceLevel":"String","DiscountBySetPrice":0,"DiscountByAmount":0,"RecurringSale":{"Days":[{"Weekday":"String","BeginHour":0,"BeginMinute":0,"EndHour":0,"EndMinute":0}]}}],"Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}