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 java.io.InputStream
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")
    open 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")
    open var Serial:String? = null

    @DataMember
    open 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")
    open 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")
    open 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")
    open 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")
    open 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")
    open 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")
    open var AppId:String? = null
}

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

    @DataMember
    open var Serial:String? = null

    @DataMember
    open var SaqPk:Long? = null

    @DataMember
    open var LocPk:Long? = null

    @DataMember
    open var Location:String? = null

    @DataMember
    open var SkuPk:Long? = null

    @DataMember
    open var SKU:String? = null

    @DataMember
    open var SadPk:Long? = null

    @DataMember
    open var Model:String? = null

    @DataMember
    open var Details:InventoryDetailBySerial? = null
}

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

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

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

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

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

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

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

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

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

    @DataMember
    open var Serial:String? = null

    @DataMember
    open var Retail:BigDecimal? = null

    @DataMember
    open var OurPrice:BigDecimal? = null

    @DataMember
    open var SalePrice:BigDecimal? = null

    @DataMember
    open var Status:String? = null

    @DataMember
    open var SaleInfo:String? = null

    @DataMember
    open var PriceA:BigDecimal? = null

    @DataMember
    open var PriceB:BigDecimal? = null

    @DataMember
    open var PriceC:BigDecimal? = null

    @DataMember
    open var MinPrice:BigDecimal? = null

    @DataMember
    open var ActiveEPrice:BigDecimal? = null

    @DataMember
    open var AllowPriceChange:Boolean? = null

    @DataMember
    open var Cost:BigDecimal? = null

    @DataMember
    open var WeightedCost:BigDecimal? = null

    @DataMember
    open var Notes:String? = null

    @DataMember
    open var Attributes:ArrayList<InventoryDetailAttribute>? = null

    @DataMember
    open var Images:ArrayList<ImageInfo>? = null

    @DataMember
    open var HasImages:Boolean? = null

    @DataMember
    open var IsActiveeHoldback:Boolean? = null

    @DataMember
    open var CustomerAcct:Int? = null

    @DataMember
    open var AvailableForSTR:Boolean? = null
}

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

    @DataMember
    open var Value:String? = null

    @DataMember
    open 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")
    open var WebType:Int? = null
}

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

    @DataMember
    open var ImageStream:String? = null

    @DataMember
    open var ImageSize:String? = null

    @DataMember
    open var ErrorMessage:String? = null

    @DataMember
    open var UriPk:Long? = null
}

Kotlin SerialDetailRequest DTOs

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

HTTP + XML

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/xml
Content-Type: application/xml
Content-Length: length

<SerialDetailRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AIM.WebService">
  <ApiKey>String</ApiKey>
  <AppId>String</AppId>
  <DeviceId>String</DeviceId>
  <OAuthToken>String</OAuthToken>
  <Token>String</Token>
  <CustomerAcct>0</CustomerAcct>
  <Pk>0</Pk>
  <Serial>String</Serial>
  <SkipImages>false</SkipImages>
</SerialDetailRequest>

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

<SerialDetailResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AIM.WebService">
  <Status>
    <DomainName>String</DomainName>
    <ErrorCode>String</ErrorCode>
    <ErrorDisplayText>String</ErrorDisplayText>
    <ErrorMessage>String</ErrorMessage>
    <IpAddress>String</IpAddress>
    <Login>String</Login>
    <StatusCode>String</StatusCode>
  </Status>
  <Details i:nil="true" />
  <LocPk>0</LocPk>
  <Location>String</Location>
  <Model>String</Model>
  <SKU>String</SKU>
  <SadPk>0</SadPk>
  <SaqPk>0</SaqPk>
  <SasPk>0</SasPk>
  <Serial>String</Serial>
  <SkuPk>0</SkuPk>
</SerialDetailResponse>