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
namespace AIM.BL.Core.Misc

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<DataContract>]
    [<AllowNullLiteral>]
    type BaseResponseResult() = 
        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", Name="StatusCode", ParameterType="body")>]
        member val StatusCode:String = null with get,set

        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", Name="Login", ParameterType="body")>]
        member val Login:String = null with get,set

        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", Name="ErrorCode", ParameterType="body")>]
        member val ErrorCode:String = null with get,set

        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", Name="ErrorDisplayText", ParameterType="body")>]
        member val ErrorDisplayText:String = null with get,set

        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", Name="ErrorMessage", ParameterType="body")>]
        member val ErrorMessage:String = null with get,set

        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="DomainName", ParameterType="body")>]
        member val DomainName:String = null with get,set

        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")>]
        member val IpAddress:String = null with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type BaseResponse() = 
        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")>]
        member val Status:BaseResponseResult = null with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type InventoryAttribute() = 
        [<DataMember>]
        member val Name:String = null with get,set

        [<DataMember>]
        member val Value:String = null with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type SerialItem() = 
        [<DataMember>]
        member val SasPk:Int64 = new Int64() with get,set

        [<DataMember>]
        member val Serial:String = null with get,set

        [<DataMember>]
        member val Retail:Decimal = new Decimal() with get,set

        [<DataMember>]
        member val OurPrice:Decimal = new Decimal() with get,set

        [<DataMember>]
        member val SalePrice:Nullable<Decimal> = new Nullable<Decimal>() with get,set

        [<DataMember>]
        member val AE_Sale_Price:Decimal = new Decimal() with get,set

        [<DataMember>]
        member val Status:String = null with get,set

        [<DataMember>]
        member val SaleInfo:String = null with get,set

        [<DataMember>]
        member val PriceA:Decimal = new Decimal() with get,set

        [<DataMember>]
        member val PriceB:Decimal = new Decimal() with get,set

        [<DataMember>]
        member val PriceC:Decimal = new Decimal() with get,set

        [<DataMember>]
        member val MinPrice:Decimal = new Decimal() with get,set

        [<DataMember>]
        member val Notes:String = null with get,set

        [<DataMember>]
        member val Source:String = null with get,set

        [<DataMember>]
        member val Attributes:IEnumerable<InventoryAttribute> = null with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type QtyByLoc() = 
        [<DataMember>]
        member val Location:String = null with get,set

        [<DataMember>]
        member val Quantity:Decimal = new Decimal() with get,set

        [<DataMember>]
        member val LocatorCode:String = null with get,set

        [<DataMember>]
        member val SerialItems:IEnumerable<SerialItem> = null with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type ActiveE3Party() = 
        [<DataMember>]
        member val Model:String = null with get,set

        [<DataMember>]
        member val Sku:String = null with get,set

        [<DataMember>]
        member val WebNumber:String = null with get,set

        [<DataMember>]
        member val Desc:String = null with get,set

        [<DataMember>]
        member val Mfg:String = null with get,set

        [<DataMember>]
        member val Type:String = null with get,set

        [<DataMember>]
        member val Barcode:String = null with get,set

        [<DataMember>]
        member val BarcodeList:ResizeArray<String> = new ResizeArray<String>() with get,set

        [<DataMember>]
        member val Selcode:String = null with get,set

        [<DataMember>]
        member val Color:String = null with get,set

        [<DataMember>]
        member val Size:String = null with get,set

        [<DataMember>]
        member val Web_Cat_1:String = null with get,set

        [<DataMember>]
        member val Web_Cat_2:String = null with get,set

        [<DataMember>]
        member val Web_Cat_3:String = null with get,set

        [<DataMember>]
        member val Web_Cat_4:String = null with get,set

        [<DataMember>]
        member val URL:String = null with get,set

        [<DataMember>]
        member val Image_Small:String = null with get,set

        [<DataMember>]
        member val Image_Medium:String = null with get,set

        [<DataMember>]
        member val Web_Desc:String = null with get,set

        [<DataMember>]
        member val Ebay_cat1:String = null with get,set

        [<DataMember>]
        member val Ebay_cat2:String = null with get,set

        [<DataMember>]
        member val Ebay_storecat1:String = null with get,set

        [<DataMember>]
        member val Ebay_storecat2:String = null with get,set

        [<DataMember>]
        member val Ebay_title:String = null with get,set

        [<DataMember>]
        member val Ebay_subtitle:String = null with get,set

        [<DataMember>]
        member val Ebay_desc:String = null with get,set

        [<DataMember>]
        member val Ebay_template:String = null with get,set

        [<DataMember>]
        member val Ebay_duration:String = null with get,set

        [<DataMember>]
        member val Ebay_format:String = null with get,set

        [<DataMember>]
        member val Ebay_paypreset:String = null with get,set

        [<DataMember>]
        member val Ebay_shippreset:String = null with get,set

        [<DataMember>]
        member val Ebay_shipdest:String = null with get,set

        [<DataMember>]
        member val Ebay_image1:String = null with get,set

        [<DataMember>]
        member val Ebay_image2:String = null with get,set

        [<DataMember>]
        member val Ebay_image3:String = null with get,set

        [<DataMember>]
        member val Ebay_image4:String = null with get,set

        [<DataMember>]
        member val Ebay_image5:String = null with get,set

        [<DataMember>]
        member val Ebay_image6:String = null with get,set

        [<DataMember>]
        member val Ebay_image7:String = null with get,set

        [<DataMember>]
        member val Ebay_image8:String = null with get,set

        [<DataMember>]
        member val Ebay_image9:String = null with get,set

        [<DataMember>]
        member val Ebay_image10:String = null with get,set

        [<DataMember>]
        member val Ebay_image11:String = null with get,set

        [<DataMember>]
        member val Ebay_image12:String = null with get,set

        [<DataMember>]
        member val Ebay_image13:String = null with get,set

        [<DataMember>]
        member val Ebay_image14:String = null with get,set

        [<DataMember>]
        member val Ebay_image15:String = null with get,set

        [<DataMember>]
        member val Ebay_image16:String = null with get,set

        [<DataMember>]
        member val Ebay_image17:String = null with get,set

        [<DataMember>]
        member val Ebay_image18:String = null with get,set

        [<DataMember>]
        member val Ebay_image19:String = null with get,set

        [<DataMember>]
        member val Ebay_image20:String = null with get,set

        [<DataMember>]
        member val Ebay_image21:String = null with get,set

        [<DataMember>]
        member val Ebay_image22:String = null with get,set

        [<DataMember>]
        member val Ebay_image23:String = null with get,set

        [<DataMember>]
        member val Ebay_image24:String = null with get,set

        [<DataMember>]
        member val ProductCode:String = null with get,set

        [<DataMember>]
        member val Dimension:String = null with get,set

        [<DataMember>]
        member val Restricted_Qtys:String = null with get,set

        [<DataMember>]
        member val Related_Products:String = null with get,set

        [<DataMember>]
        member val Upsell_Products:String = null with get,set

        [<DataMember>]
        member val Requires_Products:String = null with get,set

        [<DataMember>]
        member val Image_Large:String = null with get,set

        [<DataMember>]
        member val Audio_URL:String = null with get,set

        [<DataMember>]
        member val MPN:String = null with get,set

        [<DataMember>]
        member val Composer:String = null with get,set

        [<DataMember>]
        member val Arranger:String = null with get,set

        [<DataMember>]
        member val Artist:String = null with get,set

        [<DataMember>]
        member val Voicing:String = null with get,set

        [<DataMember>]
        member val Level:String = null with get,set

        [<DataMember>]
        member val Sample_URL:String = null with get,set

        [<DataMember>]
        member val TOC:String = null with get,set

        [<DataMember>]
        member val SE_desc:String = null with get,set

        [<DataMember>]
        member val SE_keywords:String = null with get,set

        [<DataMember>]
        member val SE_title:String = null with get,set

        [<DataMember>]
        member val Notes:String = null with get,set

        [<DataMember>]
        member val Invoice_Notes:String = null with get,set

        [<DataMember>]
        member val POS_Reminder:String = null with get,set

        [<DataMember>]
        member val LocationQtys:IEnumerable<QtyByLoc> = null with get,set

        [<DataMember>]
        member val Location_qtys:String = null with get,set

        [<DataMember>]
        member val WebcatChild1:String = null with get,set

        [<DataMember>]
        member val WebcatChild2:String = null with get,set

        [<DataMember>]
        member val WebcatChild3:String = null with get,set

        [<DataMember>]
        member val WebcatChild4:String = null with get,set

        [<DataMember>]
        member val Qty:Decimal = new Decimal() with get,set

        [<DataMember>]
        member val Qty_Available:Decimal = new Decimal() with get,set

        [<DataMember>]
        member val Cost:Decimal = new Decimal() with get,set

        [<DataMember>]
        member val Our_Price:Decimal = new Decimal() with get,set

        [<DataMember>]
        member val Retail:Decimal = new Decimal() with get,set

        [<DataMember>]
        member val Min_Price:Decimal = new Decimal() with get,set

        [<DataMember>]
        member val Price_A:Decimal = new Decimal() with get,set

        [<DataMember>]
        member val Price_B:Decimal = new Decimal() with get,set

        [<DataMember>]
        member val Price_C:Decimal = new Decimal() with get,set

        [<DataMember>]
        member val AE_Sale_Price:Decimal = new Decimal() with get,set

        [<DataMember>]
        member val Weight:Decimal = new Decimal() with get,set

        [<DataMember>]
        member val Ebay_qty:Decimal = new Decimal() with get,set

        [<DataMember>]
        member val Ebay_start:Decimal = new Decimal() with get,set

        [<DataMember>]
        member val Ebay_reserve:Decimal = new Decimal() with get,set

        [<DataMember>]
        member val Ebay_buyitnow:Decimal = new Decimal() with get,set

        [<DataMember>]
        member val WCost:Decimal = new Decimal() with get,set

        [<DataMember>]
        member val Margin_Perc:Decimal = new Decimal() with get,set

        [<DataMember>]
        member val Ebay_length:Int32 = new Int32() with get,set

        [<DataMember>]
        member val Ebay_width:Int32 = new Int32() with get,set

        [<DataMember>]
        member val Ebay_depth:Int32 = new Int32() with get,set

        [<DataMember>]
        member val Ebay_wtmajor:Int32 = new Int32() with get,set

        [<DataMember>]
        member val Ebay_wtminor:Int32 = new Int32() with get,set

        [<DataMember>]
        member val Ebay:Boolean = new Boolean() with get,set

        [<DataMember>]
        member val Web:Boolean = new Boolean() with get,set

        [<DataMember>]
        member val Published:Boolean = new Boolean() with get,set

        [<DataMember>]
        member val Approval:Boolean = new Boolean() with get,set

        [<DataMember>]
        member val Call_To_Order:Boolean = new Boolean() with get,set

        [<DataMember>]
        member val Discontinued:Boolean = new Boolean() with get,set

        [<DataMember>]
        member val SellSerialsOnline:Boolean = new Boolean() with get,set

        [<DataMember>]
        member val LastUpdated:DateTime = new DateTime() with get,set

        [<DataMember>]
        member val InventoryAttributes:IEnumerable<InventoryAttribute> = null with get,set

        [<DataMember>]
        member val ExtPk:Int64 = new Int64() with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type GetActiveE3PartyResponse() = 
        inherit BaseResponse()
        [<DataMember>]
        member val StartOffset:Int32 = new Int32() with get,set

        [<DataMember>]
        member val RecordCount:Int32 = new Int32() with get,set

        [<DataMember>]
        member val Records:ResizeArray<ActiveE3Party> = new ResizeArray<ActiveE3Party>() with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type 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")>]
        member val ApiKey:String = null with get,set

        [<DataMember>]
        [<ApiMember(DataType="string", Name="OAuthToken", ParameterType="header")>]
        member val OAuthToken:String = null with get,set

    ///<summary>
    ///GetActiveE3PartyRequires active-e Inventory Service or active-e Vortx E-Commerce or active-e 3rd Party E-Commerce
    ///</summary>
    [<DataContract>]
    [<AllowNullLiteral>]
    type GetActiveE3PartyRequest() = 
        inherit BaseRequest()
        [<DataMember>]
        member val StartOffset:Nullable<Int32> = new Nullable<Int32>() with get,set

        [<DataMember>]
        member val RecordCount:Nullable<Int32> = new Nullable<Int32>() with 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")>]
        member val InventoryType:String = null with 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")>]
        member val WebCategory:String = null with 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")>]
        member val Date:Nullable<DateTime> = new Nullable<DateTime>() with 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")>]
        member val Sku:String = null with get,set

        [<DataMember>]
        member val IncludeAttributes:Nullable<Boolean> = new Nullable<Boolean>() with get,set

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