AIM Web Services

<back to all web services

SerialDetailRequest

SerialDetail
Requires active-e Inventory Service

The following routes are available for this service:
POST, GET/api/SerialDetail
namespace AIM.WebService

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 InventoryDetailAttribute() = 
        [<DataMember>]
        member val Name:String = null with get,set

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

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

        ///<summary>
        ///1 is 'Don't Send to Web', 2 is 'Send To Web'
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="int", Description="1 is 'Don't Send to Web', 2 is 'Send To Web'", Name="WebType", ParameterType="query")>]
        member val WebType:Int32 = new Int32() with get,set

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

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

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

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

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

    [<DataContract>]
    [<AllowNullLiteral>]
    type InventoryDetailBySerial() = 
        [<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 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 ActiveEPrice:Decimal = new Decimal() with get,set

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

        [<DataMember>]
        member val Details:InventoryDetailBySerial = null 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

        ///<summary>
        ///The OAuthToken token return by AeServices30
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="The OAuthToken token return by AeServices30", IsRequired=true, Name="OAuthToken", ParameterType="Header")>]
        member val OAuthToken:String = null with get,set

        ///<summary>
        ///The Device ID of the Mobile Device. Not used for non-mobile devices.
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="The Device ID of the Mobile Device. Not used for non-mobile devices.", Name="DeviceId", ParameterType="Header")>]
        member val DeviceId:String = null with get,set

        ///<summary>
        ///An identifier for your integration
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="An identifier for your integration", IsRequired=true, Name="AppId", ParameterType="Header")>]
        member val AppId:String = null with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type BaseSecureRequest() = 
        inherit BaseRequest()
        ///<summary>
        ///The Login Token return by the Security API. Required for secured calls.
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="The Login Token return by the Security API. Required for secured calls.", Name="Token", ParameterType="Header")>]
        member val Token:String = null with get,set

    ///<summary>
    ///SerialDetailRequires active-e Inventory Service
    ///</summary>
    [<DataContract>]
    [<AllowNullLiteral>]
    type SerialDetailRequest() = 
        inherit BaseSecureRequest()
        ///<summary>
        ///The PK being used for lookup. Do not use if Serial is passed in.
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="integer", Description="The PK being used for lookup. Do not use if Serial is passed in.", Format="int64", Name="Pk", ParameterType="query")>]
        member val Pk:Nullable<Int64> = new Nullable<Int64>() with get,set

        ///<summary>
        ///The Serial# being used for lookup. Do not use if Pk is passed in.
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="The Serial# being used for lookup. Do not use if Pk is passed in.", Name="Serial", ParameterType="query")>]
        member val Serial:String = null with get,set

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

        ///<summary>
        ///If sent, the Customer Acct will be used for customer specific pricing.
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="integer", Description="If sent, the Customer Acct will be used for customer specific pricing.", Format="int32", Name="CustomerAcct", ParameterType="query")>]
        member val CustomerAcct:Nullable<Int32> = new Nullable<Int32>() with get,set

F# SerialDetailRequest 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.

POST /api/SerialDetail HTTP/1.1 
Host: active-ewebservice.biz 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"Pk":0,"Serial":"String","SkipImages":false,"CustomerAcct":0,"Token":"String","ApiKey":"String","OAuthToken":"String","DeviceId":"String","AppId":"String"}

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

{"SasPk":0,"Serial":"String","SaqPk":0,"LocPk":0,"Location":"String","SkuPk":0,"SKU":"String","SadPk":0,"Model":"String","Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}