AIM Web Services

<back to all web services

History360Request

History360
Requires active-e Customer Service.

The following routes are available for this service:
GET/api/History360
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 Contract360
            Public Sub New()
                ContractItems = New List(Of Item360)
            End Sub

            <DataMember>
            Public Overridable Property Id As String

            <DataMember>
            Public Overridable Property PaymentDate As Date

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

            <DataMember>
            Public Overridable Property AmountDue As Decimal

            <DataMember>
            Public Overridable Property LateFee As Decimal

            <DataMember>
            Public Overridable Property ContractStatus As String

            <DataMember>
            Public Overridable Property Amount As Decimal

            <DataMember>
            Public Overridable Property ContractItems As List(Of Item360)
        End Class

        '''<Summary>
        '''History360Requires active-e Customer Service.
        '''</Summary>
        <DataContract>
        Public Partial Class History360Request
            Inherits BaseSecureRequest
            <DataMember>
            Public Overridable Property CustomerAccount As Integer

            <DataMember>
            Public Overridable Property IncludeInvoices As Boolean

            <DataMember>
            Public Overridable Property IncludeOrders As Boolean

            <DataMember>
            Public Overridable Property IncludeWorkOrders As Boolean

            <DataMember>
            Public Overridable Property IncludeContracts As Boolean

            <DataMember>
            Public Overridable Property IncludeClosed As Boolean

            <DataMember>
            Public Overridable Property ClosedStartDate As Nullable(Of Date)
        End Class

        <DataContract>
        Public Partial Class History360Response
            Inherits BaseResponse
            Public Sub New()
                Invoices = New List(Of Invoice360)
                Orders = New List(Of Order360)
                WorkOrders = New List(Of WorkOrder360)
                Contracts = New List(Of Contract360)
            End Sub

            <DataMember>
            Public Overridable Property Invoices As List(Of Invoice360)

            <DataMember>
            Public Overridable Property Orders As List(Of Order360)

            <DataMember>
            Public Overridable Property WorkOrders As List(Of WorkOrder360)

            <DataMember>
            Public Overridable Property Contracts As List(Of Contract360)
        End Class

        <DataContract>
        Public Partial Class Invoice360
            Public Sub New()
                Items = New List(Of Item360)
            End Sub

            <DataMember>
            Public Overridable Property Id As String

            <DataMember>
            Public Overridable Property DueDate As Nullable(Of Date)

            <DataMember>
            Public Overridable Property Total As Decimal

            <DataMember>
            Public Overridable Property Status As String

            <DataMember>
            Public Overridable Property AmountPaid As Decimal

            <DataMember>
            Public Overridable Property LateFeeAmount As Decimal

            <DataMember>
            Public Overridable Property PurchaseDate As Date

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

            <DataMember>
            Public Overridable Property Items As List(Of Item360)
        End Class

        <DataContract>
        Public Partial Class Item360
            <DataMember>
            Public Overridable Property PslrId As Nullable(Of Long)

            <DataMember>
            Public Overridable Property Quantity As Decimal

            <DataMember>
            Public Overridable Property Price As Decimal

            <DataMember>
            Public Overridable Property TotalDiscountAmount As Decimal

            <DataMember>
            Public Overridable Property SerialNumber As String

            <DataMember>
            Public Overridable Property Condition As String
        End Class

        <DataContract>
        Public Partial Class Job360
            <DataMember>
            Public Overridable Property ItemId As String

            <DataMember>
            Public Overridable Property ItemType As String

            <DataMember>
            Public Overridable Property Title As String

            <DataMember>
            Public Overridable Property Quantity As Decimal

            <DataMember>
            Public Overridable Property Price As Decimal

            <DataMember>
            Public Overridable Property TotalDiscountAmount As Decimal

            <DataMember>
            Public Overridable Property SerialNumber As String

            <DataMember>
            Public Overridable Property Condition As String
        End Class

        <DataContract>
        Public Partial Class Order360
            <DataMember>
            Public Overridable Property Id As Integer

            <DataMember>
            Public Overridable Property [Date] As Date

            <DataMember>
            Public Overridable Property Discount As Decimal

            <DataMember>
            Public Overridable Property PaymentType As String

            <DataMember>
            Public Overridable Property SubTotal As Decimal

            <DataMember>
            Public Overridable Property Tax As Decimal

            <DataMember>
            Public Overridable Property ShippingAmount As Decimal

            <DataMember>
            Public Overridable Property Total As Decimal
        End Class

        <DataContract>
        Public Partial Class WorkOrder360
            Public Sub New()
                Jobs = New List(Of Job360)
            End Sub

            <DataMember>
            Public Overridable Property Id As String

            <DataMember>
            Public Overridable Property Status As String

            <DataMember>
            Public Overridable Property Deposit As Decimal

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

            <DataMember>
            Public Overridable Property CreationDate As Date

            <DataMember>
            Public Overridable Property CompletedDate As Nullable(Of Date)

            <DataMember>
            Public Overridable Property Price As Decimal

            <DataMember>
            Public Overridable Property Jobs As List(Of Job360)
        End Class
    End Namespace
End Namespace

VB.NET History360Request 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/History360 HTTP/1.1 
Host: active-ewebservice.biz 
Accept: text/jsonl

HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"Invoices":[{"Id":"String","DueDate":"0001-01-01T00:00:00.0000000","Total":0,"Status":"String","AmountPaid":0,"LateFeeAmount":0,"StoreLocationId":0,"Items":[{"PslrId":0,"Quantity":0,"Price":0,"TotalDiscountAmount":0,"SerialNumber":"String","Condition":"String"}]}],"Orders":[{"Id":0,"Discount":0,"PaymentType":"String","SubTotal":0,"Tax":0,"ShippingAmount":0,"Total":0}],"WorkOrders":[{"Id":"String","Status":"String","Deposit":0,"StoreLocationId":0,"CompletedDate":"0001-01-01T00:00:00.0000000","Price":0,"Jobs":[{"ItemId":"String","ItemType":"String","Title":"String","Quantity":0,"Price":0,"TotalDiscountAmount":0,"SerialNumber":"String","Condition":"String"}]}],"Contracts":[{"Id":"String","StoreLocationId":0,"AmountDue":0,"LateFee":0,"ContractStatus":"String","Amount":0,"ContractItems":[{"PslrId":0,"Quantity":0,"Price":0,"TotalDiscountAmount":0,"SerialNumber":"String","Condition":"String"}]}],"Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}