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
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using AIM.WebService;
using AIM.BL.Core.Misc;

namespace AIM.BL.Core.Misc
{
    [DataContract]
    public partial class ActiveE3Party
    {
        public ActiveE3Party()
        {
            BarcodeList = new List<string>{};
        }

        [DataMember]
        public virtual string Model { get; set; }

        [DataMember]
        public virtual string Sku { get; set; }

        [DataMember]
        public virtual string WebNumber { get; set; }

        [DataMember]
        public virtual string Desc { get; set; }

        [DataMember]
        public virtual string Mfg { get; set; }

        [DataMember]
        public virtual string Type { get; set; }

        [DataMember]
        public virtual string Barcode { get; set; }

        [DataMember]
        public virtual List<string> BarcodeList { get; set; }

        [DataMember]
        public virtual string Selcode { get; set; }

        [DataMember]
        public virtual string Color { get; set; }

        [DataMember]
        public virtual string Size { get; set; }

        [DataMember]
        public virtual string Web_Cat_1 { get; set; }

        [DataMember]
        public virtual string Web_Cat_2 { get; set; }

        [DataMember]
        public virtual string Web_Cat_3 { get; set; }

        [DataMember]
        public virtual string Web_Cat_4 { get; set; }

        [DataMember]
        public virtual string URL { get; set; }

        [DataMember]
        public virtual string Image_Small { get; set; }

        [DataMember]
        public virtual string Image_Medium { get; set; }

        [DataMember]
        public virtual string Web_Desc { get; set; }

        [DataMember]
        public virtual string Ebay_cat1 { get; set; }

        [DataMember]
        public virtual string Ebay_cat2 { get; set; }

        [DataMember]
        public virtual string Ebay_storecat1 { get; set; }

        [DataMember]
        public virtual string Ebay_storecat2 { get; set; }

        [DataMember]
        public virtual string Ebay_title { get; set; }

        [DataMember]
        public virtual string Ebay_subtitle { get; set; }

        [DataMember]
        public virtual string Ebay_desc { get; set; }

        [DataMember]
        public virtual string Ebay_template { get; set; }

        [DataMember]
        public virtual string Ebay_duration { get; set; }

        [DataMember]
        public virtual string Ebay_format { get; set; }

        [DataMember]
        public virtual string Ebay_paypreset { get; set; }

        [DataMember]
        public virtual string Ebay_shippreset { get; set; }

        [DataMember]
        public virtual string Ebay_shipdest { get; set; }

        [DataMember]
        public virtual string Ebay_image1 { get; set; }

        [DataMember]
        public virtual string Ebay_image2 { get; set; }

        [DataMember]
        public virtual string Ebay_image3 { get; set; }

        [DataMember]
        public virtual string Ebay_image4 { get; set; }

        [DataMember]
        public virtual string Ebay_image5 { get; set; }

        [DataMember]
        public virtual string Ebay_image6 { get; set; }

        [DataMember]
        public virtual string Ebay_image7 { get; set; }

        [DataMember]
        public virtual string Ebay_image8 { get; set; }

        [DataMember]
        public virtual string Ebay_image9 { get; set; }

        [DataMember]
        public virtual string Ebay_image10 { get; set; }

        [DataMember]
        public virtual string Ebay_image11 { get; set; }

        [DataMember]
        public virtual string Ebay_image12 { get; set; }

        [DataMember]
        public virtual string Ebay_image13 { get; set; }

        [DataMember]
        public virtual string Ebay_image14 { get; set; }

        [DataMember]
        public virtual string Ebay_image15 { get; set; }

        [DataMember]
        public virtual string Ebay_image16 { get; set; }

        [DataMember]
        public virtual string Ebay_image17 { get; set; }

        [DataMember]
        public virtual string Ebay_image18 { get; set; }

        [DataMember]
        public virtual string Ebay_image19 { get; set; }

        [DataMember]
        public virtual string Ebay_image20 { get; set; }

        [DataMember]
        public virtual string Ebay_image21 { get; set; }

        [DataMember]
        public virtual string Ebay_image22 { get; set; }

        [DataMember]
        public virtual string Ebay_image23 { get; set; }

        [DataMember]
        public virtual string Ebay_image24 { get; set; }

        [DataMember]
        public virtual string ProductCode { get; set; }

        [DataMember]
        public virtual string Dimension { get; set; }

        [DataMember]
        public virtual string Restricted_Qtys { get; set; }

        [DataMember]
        public virtual string Related_Products { get; set; }

        [DataMember]
        public virtual string Upsell_Products { get; set; }

        [DataMember]
        public virtual string Requires_Products { get; set; }

        [DataMember]
        public virtual string Image_Large { get; set; }

        [DataMember]
        public virtual string Audio_URL { get; set; }

        [DataMember]
        public virtual string MPN { get; set; }

        [DataMember]
        public virtual string Composer { get; set; }

        [DataMember]
        public virtual string Arranger { get; set; }

        [DataMember]
        public virtual string Artist { get; set; }

        [DataMember]
        public virtual string Voicing { get; set; }

        [DataMember]
        public virtual string Level { get; set; }

        [DataMember]
        public virtual string Sample_URL { get; set; }

        [DataMember]
        public virtual string TOC { get; set; }

        [DataMember]
        public virtual string SE_desc { get; set; }

        [DataMember]
        public virtual string SE_keywords { get; set; }

        [DataMember]
        public virtual string SE_title { get; set; }

        [DataMember]
        public virtual string Notes { get; set; }

        [DataMember]
        public virtual string Invoice_Notes { get; set; }

        [DataMember]
        public virtual string POS_Reminder { get; set; }

        [DataMember]
        public virtual IEnumerable<QtyByLoc> LocationQtys { get; set; }

        [DataMember]
        public virtual string Location_qtys { get; set; }

        [DataMember]
        public virtual string WebcatChild1 { get; set; }

        [DataMember]
        public virtual string WebcatChild2 { get; set; }

        [DataMember]
        public virtual string WebcatChild3 { get; set; }

        [DataMember]
        public virtual string WebcatChild4 { get; set; }

        [DataMember]
        public virtual decimal Qty { get; set; }

        [DataMember]
        public virtual decimal Qty_Available { get; set; }

        [DataMember]
        public virtual decimal Cost { get; set; }

        [DataMember]
        public virtual decimal Our_Price { get; set; }

        [DataMember]
        public virtual decimal Retail { get; set; }

        [DataMember]
        public virtual decimal Min_Price { get; set; }

        [DataMember]
        public virtual decimal Price_A { get; set; }

        [DataMember]
        public virtual decimal Price_B { get; set; }

        [DataMember]
        public virtual decimal Price_C { get; set; }

        [DataMember]
        public virtual decimal AE_Sale_Price { get; set; }

        [DataMember]
        public virtual decimal Weight { get; set; }

        [DataMember]
        public virtual decimal Ebay_qty { get; set; }

        [DataMember]
        public virtual decimal Ebay_start { get; set; }

        [DataMember]
        public virtual decimal Ebay_reserve { get; set; }

        [DataMember]
        public virtual decimal Ebay_buyitnow { get; set; }

        [DataMember]
        public virtual decimal WCost { get; set; }

        [DataMember]
        public virtual decimal Margin_Perc { get; set; }

        [DataMember]
        public virtual int Ebay_length { get; set; }

        [DataMember]
        public virtual int Ebay_width { get; set; }

        [DataMember]
        public virtual int Ebay_depth { get; set; }

        [DataMember]
        public virtual int Ebay_wtmajor { get; set; }

        [DataMember]
        public virtual int Ebay_wtminor { get; set; }

        [DataMember]
        public virtual bool Ebay { get; set; }

        [DataMember]
        public virtual bool Web { get; set; }

        [DataMember]
        public virtual bool Published { get; set; }

        [DataMember]
        public virtual bool Approval { get; set; }

        [DataMember]
        public virtual bool Call_To_Order { get; set; }

        [DataMember]
        public virtual bool Discontinued { get; set; }

        [DataMember]
        public virtual bool SellSerialsOnline { get; set; }

        [DataMember]
        public virtual DateTime LastUpdated { get; set; }

        [DataMember]
        public virtual IEnumerable<InventoryAttribute> InventoryAttributes { get; set; }

        [DataMember]
        public virtual long ExtPk { get; set; }
        [DataContract]
        public partial class QtyByLoc
        {
            [DataMember]
            public virtual string Location { get; set; }

            [DataMember]
            public virtual decimal Quantity { get; set; }

            [DataMember]
            public virtual string LocatorCode { get; set; }

            [DataMember]
            public virtual IEnumerable<SerialItem> SerialItems { get; set; }
        }

        [DataContract]
        public partial class InventoryAttribute
        {
            [DataMember]
            public virtual string Name { get; set; }

            [DataMember]
            public virtual string Value { get; set; }
        }

        [DataContract]
        public partial class SerialItem
        {
            [DataMember]
            public virtual long SasPk { get; set; }

            [DataMember]
            public virtual string Serial { get; set; }

            [DataMember]
            public virtual decimal Retail { get; set; }

            [DataMember]
            public virtual decimal OurPrice { get; set; }

            [DataMember]
            public virtual decimal? SalePrice { get; set; }

            [DataMember]
            public virtual decimal AE_Sale_Price { get; set; }

            [DataMember]
            public virtual string Status { get; set; }

            [DataMember]
            public virtual string SaleInfo { get; set; }

            [DataMember]
            public virtual decimal PriceA { get; set; }

            [DataMember]
            public virtual decimal PriceB { get; set; }

            [DataMember]
            public virtual decimal PriceC { get; set; }

            [DataMember]
            public virtual decimal MinPrice { get; set; }

            [DataMember]
            public virtual string Notes { get; set; }

            [DataMember]
            public virtual string Source { get; set; }

            [DataMember]
            public virtual IEnumerable<InventoryAttribute> Attributes { get; set; }
        }

    }

}

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 virtual string ApiKey { get; set; }

        [DataMember]
        [ApiMember(DataType="string", Name="OAuthToken", ParameterType="header")]
        public virtual string OAuthToken { get; set; }
    }

    [DataContract]
    public partial class BaseResponse
    {
        ///<summary>
        ///
        ///</summary>
        [DataMember]
        [ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")]
        public virtual BaseResponseResult Status { get; set; }
        [DataContract]
        public partial class BaseResponseResult
        {
            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", Name="StatusCode", ParameterType="body")]
            public virtual string StatusCode { get; set; }

            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", Name="Login", ParameterType="body")]
            public virtual string Login { get; set; }

            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", Name="ErrorCode", ParameterType="body")]
            public virtual string ErrorCode { get; set; }

            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", Name="ErrorDisplayText", ParameterType="body")]
            public virtual string ErrorDisplayText { get; set; }

            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", Name="ErrorMessage", ParameterType="body")]
            public virtual string ErrorMessage { get; set; }

            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="DomainName", ParameterType="body")]
            public virtual string DomainName { get; set; }

            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")]
            public virtual string IpAddress { get; set; }
        }

    }

    ///<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
        : BaseRequest
    {
        [DataMember]
        public virtual int? StartOffset { get; set; }

        [DataMember]
        public virtual int? RecordCount { get; set; }

        ///<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 virtual string InventoryType { get; set; }

        ///<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 virtual string WebCategory { get; set; }

        ///<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 virtual DateTime? Date { get; set; }

        ///<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 virtual string Sku { get; set; }

        [DataMember]
        public virtual bool? IncludeAttributes { get; set; }
    }

    [DataContract]
    public partial class GetActiveE3PartyResponse
        : BaseResponse
    {
        public GetActiveE3PartyResponse()
        {
            Records = new List<ActiveE3Party>{};
        }

        [DataMember]
        public virtual int StartOffset { get; set; }

        [DataMember]
        public virtual int RecordCount { get; set; }

        [DataMember]
        public virtual List<ActiveE3Party> Records { get; set; }
    }

}

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