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
import java.math.*
import java.util.*
import net.servicestack.client.*


/**
* SerialDetailRequires active-e Inventory Service
*/
@DataContract
open class SerialDetailRequest : BaseSecureRequest()
{
    /**
    * The PK being used for lookup. Do not use if Serial is passed in.
    */
    @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")
    var Pk:Long? = null

    /**
    * The Serial# being used for lookup. Do not use if Pk is passed in.
    */
    @DataMember
    @ApiMember(DataType="string", Description="The Serial# being used for lookup. Do not use if Pk is passed in.", Name="Serial", ParameterType="query")
    var Serial:String? = null

    @DataMember
    var SkipImages:Boolean? = null

    /**
    * If sent, the Customer Acct will be used for customer specific pricing.
    */
    @DataMember
    @ApiMember(DataType="integer", Description="If sent, the Customer Acct will be used for customer specific pricing.", Format="int32", Name="CustomerAcct", ParameterType="query")
    var CustomerAcct:Int? = null
}

@DataContract
open class BaseSecureRequest : BaseRequest()
{
    /**
    * The Login Token return by the Security API. Required for secured calls.
    */
    @DataMember
    @ApiMember(DataType="string", Description="The Login Token return by the Security API. Required for secured calls.", Name="Token", ParameterType="Header")
    var Token:String? = null
}

@DataContract
open class BaseRequest
{
    /**
    * This is your AIM API Key provided by Tri-Tech
    */
    @DataMember
    @ApiMember(DataType="string", Description="This is your AIM API Key provided by Tri-Tech", IsRequired=true, Name="ApiKey", ParameterType="Header")
    var ApiKey:String? = null

    /**
    * The OAuthToken token return by AeServices30
    */
    @DataMember
    @ApiMember(DataType="string", Description="The OAuthToken token return by AeServices30", IsRequired=true, Name="OAuthToken", ParameterType="Header")
    var OAuthToken:String? = null

    /**
    * The Device ID of the Mobile Device. Not used for non-mobile devices.
    */
    @DataMember
    @ApiMember(DataType="string", Description="The Device ID of the Mobile Device. Not used for non-mobile devices.", Name="DeviceId", ParameterType="Header")
    var DeviceId:String? = null

    /**
    * An identifier for your integration
    */
    @DataMember
    @ApiMember(DataType="string", Description="An identifier for your integration", IsRequired=true, Name="AppId", ParameterType="Header")
    var AppId:String? = null
}

@DataContract
open class SerialDetailResponse : BaseResponse()
{
    @DataMember
    var SasPk:Long? = null

    @DataMember
    var Serial:String? = null

    @DataMember
    var SaqPk:Long? = null

    @DataMember
    var LocPk:Long? = null

    @DataMember
    var Location:String? = null

    @DataMember
    var SkuPk:Long? = null

    @DataMember
    var SKU:String? = null

    @DataMember
    var SadPk:Long? = null

    @DataMember
    var Model:String? = null

    @DataMember
    var Details:InventoryDetailBySerial? = null
}

@DataContract
open class BaseResponse
{
    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")
    var Status:BaseResponseResult? = null
}

@DataContract
open class BaseResponseResult
{
    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", Name="StatusCode", ParameterType="body")
    var StatusCode:String? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", Name="Login", ParameterType="body")
    var Login:String? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", Name="ErrorCode", ParameterType="body")
    var ErrorCode:String? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", Name="ErrorDisplayText", ParameterType="body")
    var ErrorDisplayText:String? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", Name="ErrorMessage", ParameterType="body")
    var ErrorMessage:String? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="DomainName", ParameterType="body")
    var DomainName:String? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")
    var IpAddress:String? = null
}

@DataContract
open class InventoryDetailBySerial
{
    @DataMember
    var SasPk:Long? = null

    @DataMember
    var Serial:String? = null

    @DataMember
    var Retail:BigDecimal? = null

    @DataMember
    var OurPrice:BigDecimal? = null

    @DataMember
    var SalePrice:BigDecimal? = null

    @DataMember
    var Status:String? = null

    @DataMember
    var SaleInfo:String? = null

    @DataMember
    var PriceA:BigDecimal? = null

    @DataMember
    var PriceB:BigDecimal? = null

    @DataMember
    var PriceC:BigDecimal? = null

    @DataMember
    var MinPrice:BigDecimal? = null

    @DataMember
    var ActiveEPrice:BigDecimal? = null

    @DataMember
    var AllowPriceChange:Boolean? = null

    @DataMember
    var Cost:BigDecimal? = null

    @DataMember
    var WeightedCost:BigDecimal? = null

    @DataMember
    var Notes:String? = null

    @DataMember
    var Attributes:ArrayList<InventoryDetailAttribute> = ArrayList<InventoryDetailAttribute>()

    @DataMember
    var Images:ArrayList<ImageInfo> = ArrayList<ImageInfo>()

    @DataMember
    var HasImages:Boolean? = null

    @DataMember
    var IsActiveeHoldback:Boolean? = null

    @DataMember
    var CustomerAcct:Int? = null

    @DataMember
    var AvailableForSTR:Boolean? = null
}

@DataContract
open class InventoryDetailAttribute
{
    @DataMember
    var Name:String? = null

    @DataMember
    var Value:String? = null

    @DataMember
    var Priority:Int? = null

    /**
    * 1 is 'Don't Send to Web', 2 is 'Send To Web'
    */
    @DataMember
    @ApiMember(DataType="int", Description="1 is 'Don't Send to Web', 2 is 'Send To Web'", Name="WebType", ParameterType="query")
    var WebType:Int? = null
}

@DataContract
open class ImageInfo
{
    @DataMember
    var Url:String? = null

    @DataMember
    var ImageStream:String? = null

    @DataMember
    var ImageSize:String? = null

    @DataMember
    var ErrorMessage:String? = null

    @DataMember
    var UriPk:Long? = null
}

Kotlin 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"}}