AIM Web Services

<back to all web services

SaleInfoRequest

SaleInfo
Requires active-e Inventory Service

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

            <DataMember>
            <ApiMember(DataType:="string", Name:="OAuthToken", ParameterType:="header")>
            Public Overridable Property OAuthToken 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>
            '''
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="string", Description:="", Name:="Token", ParameterType:="Header")>
            Public Overridable Property Token As String

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

            '''<Summary>
            '''
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="string", Description:="", IsRequired:=true, Name:="AppId", ParameterType:="Header")>
            Public Overridable Property AppId 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

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"}}