AIM Web Services

<back to all web services

GetActiveE3PartyRequest

GetActiveE3Party
Requires active-e Inventory Service or active-e Vortx E-Commerce or active-e 3rd Party E-Commerce

The following routes are available for this service:
GET/api/GetActiveE3Party
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports AIM.WebService
Imports AIM.BL.Core.Misc

Namespace Global

    Namespace AIM.BL.Core.Misc

        <DataContract>
        Public Partial Class ActiveE3Party
            Public Sub New()
                BarcodeList = New List(Of String)
            End Sub

            <DataMember>
            Public Overridable Property Model As String

            <DataMember>
            Public Overridable Property Sku As String

            <DataMember>
            Public Overridable Property WebNumber As String

            <DataMember>
            Public Overridable Property Desc As String

            <DataMember>
            Public Overridable Property Mfg As String

            <DataMember>
            Public Overridable Property Type As String

            <DataMember>
            Public Overridable Property Barcode As String

            <DataMember>
            Public Overridable Property BarcodeList As List(Of String)

            <DataMember>
            Public Overridable Property Selcode As String

            <DataMember>
            Public Overridable Property Color As String

            <DataMember>
            Public Overridable Property Size As String

            <DataMember>
            Public Overridable Property Web_Cat_1 As String

            <DataMember>
            Public Overridable Property Web_Cat_2 As String

            <DataMember>
            Public Overridable Property Web_Cat_3 As String

            <DataMember>
            Public Overridable Property Web_Cat_4 As String

            <DataMember>
            Public Overridable Property URL As String

            <DataMember>
            Public Overridable Property Image_Small As String

            <DataMember>
            Public Overridable Property Image_Medium As String

            <DataMember>
            Public Overridable Property Web_Desc As String

            <DataMember>
            Public Overridable Property Ebay_cat1 As String

            <DataMember>
            Public Overridable Property Ebay_cat2 As String

            <DataMember>
            Public Overridable Property Ebay_storecat1 As String

            <DataMember>
            Public Overridable Property Ebay_storecat2 As String

            <DataMember>
            Public Overridable Property Ebay_title As String

            <DataMember>
            Public Overridable Property Ebay_subtitle As String

            <DataMember>
            Public Overridable Property Ebay_desc As String

            <DataMember>
            Public Overridable Property Ebay_template As String

            <DataMember>
            Public Overridable Property Ebay_duration As String

            <DataMember>
            Public Overridable Property Ebay_format As String

            <DataMember>
            Public Overridable Property Ebay_paypreset As String

            <DataMember>
            Public Overridable Property Ebay_shippreset As String

            <DataMember>
            Public Overridable Property Ebay_shipdest As String

            <DataMember>
            Public Overridable Property Ebay_image1 As String

            <DataMember>
            Public Overridable Property Ebay_image2 As String

            <DataMember>
            Public Overridable Property Ebay_image3 As String

            <DataMember>
            Public Overridable Property Ebay_image4 As String

            <DataMember>
            Public Overridable Property Ebay_image5 As String

            <DataMember>
            Public Overridable Property Ebay_image6 As String

            <DataMember>
            Public Overridable Property Ebay_image7 As String

            <DataMember>
            Public Overridable Property Ebay_image8 As String

            <DataMember>
            Public Overridable Property Ebay_image9 As String

            <DataMember>
            Public Overridable Property Ebay_image10 As String

            <DataMember>
            Public Overridable Property Ebay_image11 As String

            <DataMember>
            Public Overridable Property Ebay_image12 As String

            <DataMember>
            Public Overridable Property Ebay_image13 As String

            <DataMember>
            Public Overridable Property Ebay_image14 As String

            <DataMember>
            Public Overridable Property Ebay_image15 As String

            <DataMember>
            Public Overridable Property Ebay_image16 As String

            <DataMember>
            Public Overridable Property Ebay_image17 As String

            <DataMember>
            Public Overridable Property Ebay_image18 As String

            <DataMember>
            Public Overridable Property Ebay_image19 As String

            <DataMember>
            Public Overridable Property Ebay_image20 As String

            <DataMember>
            Public Overridable Property Ebay_image21 As String

            <DataMember>
            Public Overridable Property Ebay_image22 As String

            <DataMember>
            Public Overridable Property Ebay_image23 As String

            <DataMember>
            Public Overridable Property Ebay_image24 As String

            <DataMember>
            Public Overridable Property ProductCode As String

            <DataMember>
            Public Overridable Property Dimension As String

            <DataMember>
            Public Overridable Property Restricted_Qtys As String

            <DataMember>
            Public Overridable Property Related_Products As String

            <DataMember>
            Public Overridable Property Upsell_Products As String

            <DataMember>
            Public Overridable Property Requires_Products As String

            <DataMember>
            Public Overridable Property Image_Large As String

            <DataMember>
            Public Overridable Property Audio_URL As String

            <DataMember>
            Public Overridable Property MPN As String

            <DataMember>
            Public Overridable Property Composer As String

            <DataMember>
            Public Overridable Property Arranger As String

            <DataMember>
            Public Overridable Property Artist As String

            <DataMember>
            Public Overridable Property Voicing As String

            <DataMember>
            Public Overridable Property Level As String

            <DataMember>
            Public Overridable Property Sample_URL As String

            <DataMember>
            Public Overridable Property TOC As String

            <DataMember>
            Public Overridable Property SE_desc As String

            <DataMember>
            Public Overridable Property SE_keywords As String

            <DataMember>
            Public Overridable Property SE_title As String

            <DataMember>
            Public Overridable Property Notes As String

            <DataMember>
            Public Overridable Property Invoice_Notes As String

            <DataMember>
            Public Overridable Property POS_Reminder As String

            <DataMember>
            Public Overridable Property LocationQtys As IEnumerable(Of QtyByLoc)

            <DataMember>
            Public Overridable Property Location_qtys As String

            <DataMember>
            Public Overridable Property WebcatChild1 As String

            <DataMember>
            Public Overridable Property WebcatChild2 As String

            <DataMember>
            Public Overridable Property WebcatChild3 As String

            <DataMember>
            Public Overridable Property WebcatChild4 As String

            <DataMember>
            Public Overridable Property Qty As Decimal

            <DataMember>
            Public Overridable Property Qty_Available As Decimal

            <DataMember>
            Public Overridable Property Cost As Decimal

            <DataMember>
            Public Overridable Property Our_Price As Decimal

            <DataMember>
            Public Overridable Property Retail As Decimal

            <DataMember>
            Public Overridable Property Min_Price As Decimal

            <DataMember>
            Public Overridable Property Price_A As Decimal

            <DataMember>
            Public Overridable Property Price_B As Decimal

            <DataMember>
            Public Overridable Property Price_C As Decimal

            <DataMember>
            Public Overridable Property AE_Sale_Price As Decimal

            <DataMember>
            Public Overridable Property Weight As Decimal

            <DataMember>
            Public Overridable Property Ebay_qty As Decimal

            <DataMember>
            Public Overridable Property Ebay_start As Decimal

            <DataMember>
            Public Overridable Property Ebay_reserve As Decimal

            <DataMember>
            Public Overridable Property Ebay_buyitnow As Decimal

            <DataMember>
            Public Overridable Property WCost As Decimal

            <DataMember>
            Public Overridable Property Margin_Perc As Decimal

            <DataMember>
            Public Overridable Property Ebay_length As Integer

            <DataMember>
            Public Overridable Property Ebay_width As Integer

            <DataMember>
            Public Overridable Property Ebay_depth As Integer

            <DataMember>
            Public Overridable Property Ebay_wtmajor As Integer

            <DataMember>
            Public Overridable Property Ebay_wtminor As Integer

            <DataMember>
            Public Overridable Property Ebay As Boolean

            <DataMember>
            Public Overridable Property Web As Boolean

            <DataMember>
            Public Overridable Property Published As Boolean

            <DataMember>
            Public Overridable Property Approval As Boolean

            <DataMember>
            Public Overridable Property Call_To_Order As Boolean

            <DataMember>
            Public Overridable Property Discontinued As Boolean

            <DataMember>
            Public Overridable Property SellSerialsOnline As Boolean

            <DataMember>
            Public Overridable Property LastUpdated As Date

            <DataMember>
            Public Overridable Property InventoryAttributes As IEnumerable(Of InventoryAttribute)

            <DataMember>
            Public Overridable Property ExtPk As Long

            <DataContract>
            Public Partial Class QtyByLoc
                <DataMember>
                Public Overridable Property Location As String

                <DataMember>
                Public Overridable Property Quantity As Decimal

                <DataMember>
                Public Overridable Property LocatorCode As String

                <DataMember>
                Public Overridable Property SerialItems As IEnumerable(Of SerialItem)
            End Class

            <DataContract>
            Public Partial Class InventoryAttribute
                <DataMember>
                Public Overridable Property Name As String

                <DataMember>
                Public Overridable Property Value As String
            End Class

            <DataContract>
            Public Partial Class SerialItem
                <DataMember>
                Public Overridable Property SasPk As Long

                <DataMember>
                Public Overridable Property Serial As String

                <DataMember>
                Public Overridable Property Retail As Decimal

                <DataMember>
                Public Overridable Property OurPrice As Decimal

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

                <DataMember>
                Public Overridable Property AE_Sale_Price As Decimal

                <DataMember>
                Public Overridable Property Status As String

                <DataMember>
                Public Overridable Property SaleInfo As String

                <DataMember>
                Public Overridable Property PriceA As Decimal

                <DataMember>
                Public Overridable Property PriceB As Decimal

                <DataMember>
                Public Overridable Property PriceC As Decimal

                <DataMember>
                Public Overridable Property MinPrice As Decimal

                <DataMember>
                Public Overridable Property Notes As String

                <DataMember>
                Public Overridable Property Source As String

                <DataMember>
                Public Overridable Property Attributes As IEnumerable(Of InventoryAttribute)
            End Class
        End Class
    End Namespace

    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

        '''<Summary>
        '''GetActiveE3PartyRequires active-e Inventory Service or active-e Vortx E-Commerce or active-e 3rd Party E-Commerce
        '''</Summary>
        <DataContract>
        Public Partial Class GetActiveE3PartyRequest
            Inherits BaseRequest
            <DataMember>
            Public Overridable Property StartOffset As Nullable(Of Integer)

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

            '''<Summary>
            '''Inventory, Packages, or NI. Defaults to Inventory.
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="string", Description:="Inventory, Packages, or NI. Defaults to Inventory.", Name:="InventoryType", ParameterType:="query")>
            Public Overridable Property InventoryType As String

            '''<Summary>
            '''Only Items in the sent WebCategory will be returned
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="string", Description:="Only Items in the sent WebCategory will be returned", Name:="WebCategory", ParameterType:="query")>
            Public Overridable Property WebCategory As String

            '''<Summary>
            '''If sent, only grab 3 Party Feed records updated after the date passed.
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="string", Description:="If sent, only grab 3 Party Feed records updated after the date passed.", Format:="date", Name:="Date", ParameterType:="query")>
            Public Overridable Property [Date] As Nullable(Of Date)

            '''<Summary>
            '''If sent, only the SKU sent will be returned
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="string", Description:="If sent, only the SKU sent will be returned", Name:="Sku", ParameterType:="query")>
            Public Overridable Property Sku As String

            <DataMember>
            Public Overridable Property IncludeAttributes As Nullable(Of Boolean)
        End Class

        <DataContract>
        Public Partial Class GetActiveE3PartyResponse
            Inherits BaseResponse
            Public Sub New()
                Records = New List(Of ActiveE3Party)
            End Sub

            <DataMember>
            Public Overridable Property StartOffset As Integer

            <DataMember>
            Public Overridable Property RecordCount As Integer

            <DataMember>
            Public Overridable Property Records As List(Of ActiveE3Party)
        End Class
    End Namespace
End Namespace

VB.NET GetActiveE3PartyRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /api/GetActiveE3Party HTTP/1.1 
Host: active-ewebservice.biz 
Accept: application/json

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

{"StartOffset":0,"RecordCount":0,"Records":[{"Model":"String","Sku":"String","WebNumber":"String","Desc":"String","Mfg":"String","Type":"String","Barcode":"String","BarcodeList":["String"],"Selcode":"String","Color":"String","Size":"String","Web_Cat_1":"String","Web_Cat_2":"String","Web_Cat_3":"String","Web_Cat_4":"String","URL":"String","Image_Small":"String","Image_Medium":"String","Web_Desc":"String","Ebay_cat1":"String","Ebay_cat2":"String","Ebay_storecat1":"String","Ebay_storecat2":"String","Ebay_title":"String","Ebay_subtitle":"String","Ebay_desc":"String","Ebay_template":"String","Ebay_duration":"String","Ebay_format":"String","Ebay_paypreset":"String","Ebay_shippreset":"String","Ebay_shipdest":"String","Ebay_image1":"String","Ebay_image2":"String","Ebay_image3":"String","Ebay_image4":"String","Ebay_image5":"String","Ebay_image6":"String","Ebay_image7":"String","Ebay_image8":"String","Ebay_image9":"String","Ebay_image10":"String","Ebay_image11":"String","Ebay_image12":"String","Ebay_image13":"String","Ebay_image14":"String","Ebay_image15":"String","Ebay_image16":"String","Ebay_image17":"String","Ebay_image18":"String","Ebay_image19":"String","Ebay_image20":"String","Ebay_image21":"String","Ebay_image22":"String","Ebay_image23":"String","Ebay_image24":"String","ProductCode":"String","Dimension":"String","Restricted_Qtys":"String","Related_Products":"String","Upsell_Products":"String","Requires_Products":"String","Image_Large":"String","Audio_URL":"String","MPN":"String","Composer":"String","Arranger":"String","Artist":"String","Voicing":"String","Level":"String","Sample_URL":"String","TOC":"String","SE_desc":"String","SE_keywords":"String","SE_title":"String","Notes":"String","Invoice_Notes":"String","POS_Reminder":"String","Location_qtys":"String","WebcatChild1":"String","WebcatChild2":"String","WebcatChild3":"String","WebcatChild4":"String","Qty":0,"Qty_Available":0,"Cost":0,"Our_Price":0,"Retail":0,"Min_Price":0,"Price_A":0,"Price_B":0,"Price_C":0,"AE_Sale_Price":0,"Weight":0,"Ebay_qty":0,"Ebay_start":0,"Ebay_reserve":0,"Ebay_buyitnow":0,"WCost":0,"Margin_Perc":0,"Ebay_length":0,"Ebay_width":0,"Ebay_depth":0,"Ebay_wtmajor":0,"Ebay_wtminor":0,"Ebay":false,"Web":false,"Published":false,"Approval":false,"Call_To_Order":false,"Discontinued":false,"SellSerialsOnline":false,"ExtPk":0}],"Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}