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()
{
    /**
    * The Login Token return by the Security API. Required for secured calls.
    */
    @DataMember
    @ApiMember(DataType="string", Description="The Login Token return by the Security API. Required for secured calls.", Name="Token", ParameterType="Header")
    var Token: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

    /**
    * The OAuthToken token return by AeServices30
    */
    @DataMember
    @ApiMember(DataType="string", Description="The OAuthToken token return by AeServices30", IsRequired=true, Name="OAuthToken", ParameterType="Header")
    var OAuthToken:String? = null

    /**
    * The Device ID of the Mobile Device. Not used for non-mobile devices.
    */
    @DataMember
    @ApiMember(DataType="string", Description="The Device ID of the Mobile Device. Not used for non-mobile devices.", Name="DeviceId", ParameterType="Header")
    var DeviceId:String? = null

    /**
    * An identifier for your integration
    */
    @DataMember
    @ApiMember(DataType="string", Description="An identifier for your integration", IsRequired=true, Name="AppId", ParameterType="Header")
    var AppId: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 .xml suffix or ?format=xml

HTTP + XML

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/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<SaleInfoResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AIM.WebService">
  <Status>
    <DomainName>String</DomainName>
    <ErrorCode>String</ErrorCode>
    <ErrorDisplayText>String</ErrorDisplayText>
    <ErrorMessage>String</ErrorMessage>
    <IpAddress>String</IpAddress>
    <Login>String</Login>
    <StatusCode>String</StatusCode>
  </Status>
  <SaleRecords>
    <SaleRecord>
      <Condition>String</Condition>
      <CustomerAccount>0</CustomerAccount>
      <CustomerDefaultId>0</CustomerDefaultId>
      <DiscountByAmount>0</DiscountByAmount>
      <DiscountByPriceLevel>String</DiscountByPriceLevel>
      <DiscountBySetPrice>0</DiscountBySetPrice>
      <DiscountFromPriceLevel>
        <BasePriceLevel>String</BasePriceLevel>
        <DisountPercentage>0</DisountPercentage>
      </DiscountFromPriceLevel>
      <EndDate>0001-01-01T00:00:00</EndDate>
      <LocationId>0</LocationId>
      <Model>String</Model>
      <RecurringSale>
        <Days>
          <RecurringSaleDay>
            <BeginHour>0</BeginHour>
            <BeginMinute>0</BeginMinute>
            <EndHour>0</EndHour>
            <EndMinute>0</EndMinute>
            <Weekday>String</Weekday>
          </RecurringSaleDay>
        </Days>
      </RecurringSale>
      <SKU>String</SKU>
      <SadPk>0</SadPk>
      <SaqPk>0</SaqPk>
      <SkuPk>0</SkuPk>
      <StartDate>0001-01-01T00:00:00</StartDate>
    </SaleRecord>
  </SaleRecords>
</SaleInfoResponse>