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
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports AIM.WebService

Namespace Global

    Namespace AIM.WebService

        <DataContract>
        Public Partial Class 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")>
            Public Overridable Property ApiKey As String

            '''<Summary>
            '''The OAuthToken token return by AeServices30
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="string", Description:="The OAuthToken token return by AeServices30", IsRequired:=true, Name:="OAuthToken", ParameterType:="Header")>
            Public Overridable Property OAuthToken As String

            '''<Summary>
            '''The Device ID of the Mobile Device. Not used for non-mobile devices.
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="string", Description:="The Device ID of the Mobile Device. Not used for non-mobile devices.", Name:="DeviceId", ParameterType:="Header")>
            Public Overridable Property DeviceId As String

            '''<Summary>
            '''An identifier for your integration
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="string", Description:="An identifier for your integration", IsRequired:=true, Name:="AppId", ParameterType:="Header")>
            Public Overridable Property AppId As String
        End Class

        <DataContract>
        Public Partial Class BaseResponse
            '''<Summary>
            '''
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="BaseResponseResult", Description:="", Name:="Status", ParameterType:="body")>
            Public Overridable Property Status As BaseResponseResult

            <DataContract>
            Public Partial Class BaseResponseResult
                '''<Summary>
                '''
                '''</Summary>
                <DataMember>
                <ApiMember(DataType:="string", Description:="", Name:="StatusCode", ParameterType:="body")>
                Public Overridable Property StatusCode As String

                '''<Summary>
                '''
                '''</Summary>
                <DataMember>
                <ApiMember(DataType:="string", Description:="", Name:="Login", ParameterType:="body")>
                Public Overridable Property Login As String

                '''<Summary>
                '''
                '''</Summary>
                <DataMember>
                <ApiMember(DataType:="string", Description:="", Name:="ErrorCode", ParameterType:="body")>
                Public Overridable Property ErrorCode As String

                '''<Summary>
                '''
                '''</Summary>
                <DataMember>
                <ApiMember(DataType:="string", Description:="", Name:="ErrorDisplayText", ParameterType:="body")>
                Public Overridable Property ErrorDisplayText As String

                '''<Summary>
                '''
                '''</Summary>
                <DataMember>
                <ApiMember(DataType:="string", Description:="", Name:="ErrorMessage", ParameterType:="body")>
                Public Overridable Property ErrorMessage As String

                '''<Summary>
                '''
                '''</Summary>
                <DataMember>
                <ApiMember(DataType:="string", Description:="", ExcludeInSchema:=true, Name:="DomainName", ParameterType:="body")>
                Public Overridable Property DomainName As String

                '''<Summary>
                '''
                '''</Summary>
                <DataMember>
                <ApiMember(DataType:="string", Description:="", ExcludeInSchema:=true, Name:="IPAddress", ParameterType:="body")>
                Public Overridable Property IpAddress As String
            End Class
        End Class

        <DataContract>
        Public Partial Class BaseSecureRequest
            Inherits BaseRequest
            '''<Summary>
            '''The Login Token return by the Security API. Required for secured calls.
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="string", Description:="The Login Token return by the Security API. Required for secured calls.", Name:="Token", ParameterType:="Header")>
            Public Overridable Property Token As String
        End Class

        <DataContract>
        Public Partial Class DiscountFromPriceLevel
            <DataMember>
            Public Overridable Property BasePriceLevel As String

            <DataMember>
            Public Overridable Property DisountPercentage As Decimal
        End Class

        <DataContract>
        Public Partial Class RecurringSaleDay
            <DataMember>
            Public Overridable Property Weekday As String

            <DataMember>
            Public Overridable Property BeginHour As Integer

            <DataMember>
            Public Overridable Property BeginMinute As Integer

            <DataMember>
            Public Overridable Property EndHour As Integer

            <DataMember>
            Public Overridable Property EndMinute As Integer
        End Class

        <DataContract>
        Public Partial Class RecurringSaleInfo
            Public Sub New()
                Days = New List(Of RecurringSaleDay)
            End Sub

            <DataMember>
            Public Overridable Property Days As List(Of RecurringSaleDay)
        End Class

        '''<Summary>
        '''SaleInfoRequires active-e Inventory Service
        '''</Summary>
        <DataContract>
        Public Partial Class SaleInfoRequest
            Inherits BaseSecureRequest
            <DataMember>
            Public Overridable Property LocationId As Nullable(Of Long)

            '''<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")>
            Public Overridable Property DateTime As Nullable(Of Date)
        End Class

        <DataContract>
        Public Partial Class SaleInfoResponse
            Inherits BaseResponse
            Public Sub New()
                SaleRecords = New List(Of SaleRecord)
            End Sub

            <DataMember>
            Public Overridable Property SaleRecords As List(Of SaleRecord)
        End Class

        <DataContract>
        Public Partial Class SaleRecord
            <DataMember>
            Public Overridable Property SadPk As Long

            <DataMember>
            Public Overridable Property SkuPk As Long

            <DataMember>
            Public Overridable Property SaqPk As Long

            <DataMember>
            Public Overridable Property Model As String

            <DataMember>
            Public Overridable Property SKU As String

            <DataMember>
            Public Overridable Property LocationId As Long

            <DataMember>
            Public Overridable Property StartDate As Date

            <DataMember>
            Public Overridable Property EndDate As Date

            <DataMember>
            Public Overridable Property CustomerAccount As Nullable(Of Integer)

            <DataMember>
            Public Overridable Property CustomerDefaultId As Nullable(Of Long)

            <DataMember>
            Public Overridable Property Condition As String

            <DataMember>
            Public Overridable Property DiscountFromPriceLevel As DiscountFromPriceLevel

            <DataMember>
            Public Overridable Property DiscountByPriceLevel As String

            <DataMember>
            Public Overridable Property DiscountBySetPrice As Nullable(Of Decimal)

            <DataMember>
            Public Overridable Property DiscountByAmount As Nullable(Of Decimal)

            <DataMember>
            Public Overridable Property RecurringSale As RecurringSaleInfo
        End Class
    End Namespace
End Namespace

VB.NET 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>