AIM Web Services

<back to all web services

SaleInfoRequest

SaleInfo
Requires active-e Inventory Service

The following routes are available for this service:
GET/api/SaleInfo
import java.math.*
import java.util.*
import net.servicestack.client.*


/**
* SaleInfoRequires active-e Inventory Service
*/
@DataContract
open class SaleInfoRequest : BaseSecureRequest()
{
    @DataMember
    var LocationId:Long? = null

    /**
    * If sent, only sales that are active during the sent Date/Time are returned. Otherwise, the current Date/Time is used
    */
    @DataMember
    @ApiMember(Description="If sent, only sales that are active during the sent Date/Time are returned. Otherwise, the current Date/Time is used", Name="DateTime")
    var DateTime:Date? = null
}

@DataContract
open class BaseSecureRequest : BaseRequest()
{
    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", Name="Token", ParameterType="Header")
    var Token:String? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", Name="DeviceId", ParameterType="Header")
    var DeviceId:String? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", IsRequired=true, Name="AppId", ParameterType="Header")
    var AppId:String? = null
}

@DataContract
open class BaseRequest
{
    /**
    * This is your AIM API Key provided by Tri-Tech
    */
    @DataMember
    @ApiMember(DataType="string", Description="This is your AIM API Key provided by Tri-Tech", IsRequired=true, Name="ApiKey", ParameterType="header")
    var ApiKey:String? = null

    @DataMember
    @ApiMember(DataType="string", Name="OAuthToken", ParameterType="header")
    var OAuthToken:String? = null
}

@DataContract
open class SaleInfoResponse : BaseResponse()
{
    @DataMember
    var SaleRecords:ArrayList<SaleRecord> = ArrayList<SaleRecord>()
}

@DataContract
open class BaseResponse
{
    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")
    var Status:BaseResponseResult? = null
}

@DataContract
open class BaseResponseResult
{
    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", Name="StatusCode", ParameterType="body")
    var StatusCode:String? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", Name="Login", ParameterType="body")
    var Login:String? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", Name="ErrorCode", ParameterType="body")
    var ErrorCode:String? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", Name="ErrorDisplayText", ParameterType="body")
    var ErrorDisplayText:String? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", Name="ErrorMessage", ParameterType="body")
    var ErrorMessage:String? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="DomainName", ParameterType="body")
    var DomainName:String? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")
    var IpAddress:String? = null
}

@DataContract
open class SaleRecord
{
    @DataMember
    var SadPk:Long? = null

    @DataMember
    var SkuPk:Long? = null

    @DataMember
    var SaqPk:Long? = null

    @DataMember
    var Model:String? = null

    @DataMember
    var SKU:String? = null

    @DataMember
    var LocationId:Long? = null

    @DataMember
    var StartDate:Date? = null

    @DataMember
    var EndDate:Date? = null

    @DataMember
    var CustomerAccount:Int? = null

    @DataMember
    var CustomerDefaultId:Long? = null

    @DataMember
    var Condition:String? = null

    @DataMember
    var DiscountFromPriceLevel:DiscountFromPriceLevel? = null

    @DataMember
    var DiscountByPriceLevel:String? = null

    @DataMember
    var DiscountBySetPrice:BigDecimal? = null

    @DataMember
    var DiscountByAmount:BigDecimal? = null

    @DataMember
    var RecurringSale:RecurringSaleInfo? = null
}

@DataContract
open class DiscountFromPriceLevel
{
    @DataMember
    var BasePriceLevel:String? = null

    @DataMember
    var DisountPercentage:BigDecimal? = null
}

@DataContract
open class RecurringSaleInfo
{
    @DataMember
    var Days:ArrayList<RecurringSaleDay> = ArrayList<RecurringSaleDay>()
}

@DataContract
open class RecurringSaleDay
{
    @DataMember
    var Weekday:String? = null

    @DataMember
    var BeginHour:Int? = null

    @DataMember
    var BeginMinute:Int? = null

    @DataMember
    var EndHour:Int? = null

    @DataMember
    var EndMinute:Int? = null
}

Kotlin SaleInfoRequest DTOs

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.

GET /api/SaleInfo HTTP/1.1 
Host: active-ewebservice.biz 
Accept: text/jsonl

HTTP/1.1 200 OK
Content-Type: text/jsonl
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"}}