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
namespace AIM.WebService

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<DataContract>]
    [<AllowNullLiteral>]
    type BaseResponseResult() = 
        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", Name="StatusCode", ParameterType="body")>]
        member val StatusCode:String = null with get,set

        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", Name="Login", ParameterType="body")>]
        member val Login:String = null with get,set

        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", Name="ErrorCode", ParameterType="body")>]
        member val ErrorCode:String = null with get,set

        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", Name="ErrorDisplayText", ParameterType="body")>]
        member val ErrorDisplayText:String = null with get,set

        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", Name="ErrorMessage", ParameterType="body")>]
        member val ErrorMessage:String = null with get,set

        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="DomainName", ParameterType="body")>]
        member val DomainName:String = null with get,set

        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")>]
        member val IpAddress:String = null with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type BaseResponse() = 
        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")>]
        member val Status:BaseResponseResult = null with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type DiscountFromPriceLevel() = 
        [<DataMember>]
        member val BasePriceLevel:String = null with get,set

        [<DataMember>]
        member val DisountPercentage:Decimal = new Decimal() with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type RecurringSaleDay() = 
        [<DataMember>]
        member val Weekday:String = null with get,set

        [<DataMember>]
        member val BeginHour:Int32 = new Int32() with get,set

        [<DataMember>]
        member val BeginMinute:Int32 = new Int32() with get,set

        [<DataMember>]
        member val EndHour:Int32 = new Int32() with get,set

        [<DataMember>]
        member val EndMinute:Int32 = new Int32() with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type RecurringSaleInfo() = 
        [<DataMember>]
        member val Days:ResizeArray<RecurringSaleDay> = new ResizeArray<RecurringSaleDay>() with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type SaleRecord() = 
        [<DataMember>]
        member val SadPk:Int64 = new Int64() with get,set

        [<DataMember>]
        member val SkuPk:Int64 = new Int64() with get,set

        [<DataMember>]
        member val SaqPk:Int64 = new Int64() with get,set

        [<DataMember>]
        member val Model:String = null with get,set

        [<DataMember>]
        member val SKU:String = null with get,set

        [<DataMember>]
        member val LocationId:Int64 = new Int64() with get,set

        [<DataMember>]
        member val StartDate:DateTime = new DateTime() with get,set

        [<DataMember>]
        member val EndDate:DateTime = new DateTime() with get,set

        [<DataMember>]
        member val CustomerAccount:Nullable<Int32> = new Nullable<Int32>() with get,set

        [<DataMember>]
        member val CustomerDefaultId:Nullable<Int64> = new Nullable<Int64>() with get,set

        [<DataMember>]
        member val Condition:String = null with get,set

        [<DataMember>]
        member val DiscountFromPriceLevel:DiscountFromPriceLevel = null with get,set

        [<DataMember>]
        member val DiscountByPriceLevel:String = null with get,set

        [<DataMember>]
        member val DiscountBySetPrice:Nullable<Decimal> = new Nullable<Decimal>() with get,set

        [<DataMember>]
        member val DiscountByAmount:Nullable<Decimal> = new Nullable<Decimal>() with get,set

        [<DataMember>]
        member val RecurringSale:RecurringSaleInfo = null with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type SaleInfoResponse() = 
        inherit BaseResponse()
        [<DataMember>]
        member val SaleRecords:ResizeArray<SaleRecord> = new ResizeArray<SaleRecord>() with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type BaseRequest() = 
        ///<summary>
        ///This is your AIM API Key provided by Tri-Tech
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="This is your AIM API Key provided by Tri-Tech", IsRequired=true, Name="ApiKey", ParameterType="header")>]
        member val ApiKey:String = null with get,set

        [<DataMember>]
        [<ApiMember(DataType="string", Name="OAuthToken", ParameterType="header")>]
        member val OAuthToken:String = null with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type BaseSecureRequest() = 
        inherit BaseRequest()
        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", Name="Token", ParameterType="Header")>]
        member val Token:String = null with get,set

        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", Name="DeviceId", ParameterType="Header")>]
        member val DeviceId:String = null with get,set

        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", IsRequired=true, Name="AppId", ParameterType="Header")>]
        member val AppId:String = null with get,set

    ///<summary>
    ///SaleInfoRequires active-e Inventory Service
    ///</summary>
    [<DataContract>]
    [<AllowNullLiteral>]
    type SaleInfoRequest() = 
        inherit BaseSecureRequest()
        [<DataMember>]
        member val LocationId:Nullable<Int64> = new Nullable<Int64>() with get,set

        ///<summary>
        ///If sent, only sales that are active during the sent Date/Time are returned. Otherwise, the current Date/Time is used
        ///</summary>
        [<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")>]
        member val DateTime:Nullable<DateTime> = new Nullable<DateTime>() with get,set

F# 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>