AIM Web Services

<back to all web services

SerialDetailRequest

SerialDetail
Requires active-e Inventory Service

import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    /**
    * SerialDetailRequires active-e Inventory Service
    */
    @DataContract
    public static class SerialDetailRequest extends 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")
        public Long Pk = 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")
        public String Serial = null;

        @DataMember
        public Boolean SkipImages = 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")
        public Integer CustomerAcct = null;
        
        public Long getPk() { return Pk; }
        public SerialDetailRequest setPk(Long value) { this.Pk = value; return this; }
        public String getSerial() { return Serial; }
        public SerialDetailRequest setSerial(String value) { this.Serial = value; return this; }
        public Boolean isSkipImages() { return SkipImages; }
        public SerialDetailRequest setSkipImages(Boolean value) { this.SkipImages = value; return this; }
        public Integer getCustomerAcct() { return CustomerAcct; }
        public SerialDetailRequest setCustomerAcct(Integer value) { this.CustomerAcct = value; return this; }
    }

    @DataContract
    public static class BaseSecureRequest extends 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")
        public String Token = null;
        
        public String getToken() { return Token; }
        public BaseSecureRequest setToken(String value) { this.Token = value; return this; }
    }

    @DataContract
    public static 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")
        public String ApiKey = null;

        /**
        * The OAuthToken token return by AeServices30
        */
        @DataMember
        @ApiMember(DataType="string", Description="The OAuthToken token return by AeServices30", IsRequired=true, Name="OAuthToken", ParameterType="Header")
        public String OAuthToken = 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")
        public String DeviceId = null;

        /**
        * An identifier for your integration
        */
        @DataMember
        @ApiMember(DataType="string", Description="An identifier for your integration", IsRequired=true, Name="AppId", ParameterType="Header")
        public String AppId = null;
        
        public String getApiKey() { return ApiKey; }
        public BaseRequest setApiKey(String value) { this.ApiKey = value; return this; }
        public String getOAuthToken() { return OAuthToken; }
        public BaseRequest setOAuthToken(String value) { this.OAuthToken = value; return this; }
        public String getDeviceId() { return DeviceId; }
        public BaseRequest setDeviceId(String value) { this.DeviceId = value; return this; }
        public String getAppId() { return AppId; }
        public BaseRequest setAppId(String value) { this.AppId = value; return this; }
    }

    @DataContract
    public static class SerialDetailResponse extends BaseResponse
    {
        @DataMember
        public Long SasPk = null;

        @DataMember
        public String Serial = null;

        @DataMember
        public Long SaqPk = null;

        @DataMember
        public Long LocPk = null;

        @DataMember
        public String Location = null;

        @DataMember
        public Long SkuPk = null;

        @DataMember
        public String SKU = null;

        @DataMember
        public Long SadPk = null;

        @DataMember
        public String Model = null;

        @DataMember
        public InventoryDetailBySerial Details = null;
        
        public Long getSasPk() { return SasPk; }
        public SerialDetailResponse setSasPk(Long value) { this.SasPk = value; return this; }
        public String getSerial() { return Serial; }
        public SerialDetailResponse setSerial(String value) { this.Serial = value; return this; }
        public Long getSaqPk() { return SaqPk; }
        public SerialDetailResponse setSaqPk(Long value) { this.SaqPk = value; return this; }
        public Long getLocPk() { return LocPk; }
        public SerialDetailResponse setLocPk(Long value) { this.LocPk = value; return this; }
        public String getLocation() { return Location; }
        public SerialDetailResponse setLocation(String value) { this.Location = value; return this; }
        public Long getSkuPk() { return SkuPk; }
        public SerialDetailResponse setSkuPk(Long value) { this.SkuPk = value; return this; }
        public String getSku() { return SKU; }
        public SerialDetailResponse setSku(String value) { this.SKU = value; return this; }
        public Long getSadPk() { return SadPk; }
        public SerialDetailResponse setSadPk(Long value) { this.SadPk = value; return this; }
        public String getModel() { return Model; }
        public SerialDetailResponse setModel(String value) { this.Model = value; return this; }
        public InventoryDetailBySerial getDetails() { return Details; }
        public SerialDetailResponse setDetails(InventoryDetailBySerial value) { this.Details = value; return this; }
    }

    @DataContract
    public static class BaseResponse
    {
        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")
        public BaseResponseResult Status = null;
        
        public BaseResponseResult getStatus() { return Status; }
        public BaseResponse setStatus(BaseResponseResult value) { this.Status = value; return this; }
    }

    @DataContract
    public static class BaseResponseResult
    {
        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="string", Description="", Name="StatusCode", ParameterType="body")
        public String StatusCode = null;

        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="string", Description="", Name="Login", ParameterType="body")
        public String Login = null;

        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="string", Description="", Name="ErrorCode", ParameterType="body")
        public String ErrorCode = null;

        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="string", Description="", Name="ErrorDisplayText", ParameterType="body")
        public String ErrorDisplayText = null;

        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="string", Description="", Name="ErrorMessage", ParameterType="body")
        public String ErrorMessage = null;

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

        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")
        public String IpAddress = null;
        
        public String getStatusCode() { return StatusCode; }
        public BaseResponseResult setStatusCode(String value) { this.StatusCode = value; return this; }
        public String getLogin() { return Login; }
        public BaseResponseResult setLogin(String value) { this.Login = value; return this; }
        public String getErrorCode() { return ErrorCode; }
        public BaseResponseResult setErrorCode(String value) { this.ErrorCode = value; return this; }
        public String getErrorDisplayText() { return ErrorDisplayText; }
        public BaseResponseResult setErrorDisplayText(String value) { this.ErrorDisplayText = value; return this; }
        public String getErrorMessage() { return ErrorMessage; }
        public BaseResponseResult setErrorMessage(String value) { this.ErrorMessage = value; return this; }
        public String getDomainName() { return DomainName; }
        public BaseResponseResult setDomainName(String value) { this.DomainName = value; return this; }
        public String getIpAddress() { return IpAddress; }
        public BaseResponseResult setIpAddress(String value) { this.IpAddress = value; return this; }
    }

    @DataContract
    public static class InventoryDetailBySerial
    {
        @DataMember
        public Long SasPk = null;

        @DataMember
        public String Serial = null;

        @DataMember
        public BigDecimal Retail = null;

        @DataMember
        public BigDecimal OurPrice = null;

        @DataMember
        public BigDecimal SalePrice = null;

        @DataMember
        public String Status = null;

        @DataMember
        public String SaleInfo = null;

        @DataMember
        public BigDecimal PriceA = null;

        @DataMember
        public BigDecimal PriceB = null;

        @DataMember
        public BigDecimal PriceC = null;

        @DataMember
        public BigDecimal MinPrice = null;

        @DataMember
        public BigDecimal ActiveEPrice = null;

        @DataMember
        public Boolean AllowPriceChange = null;

        @DataMember
        public BigDecimal Cost = null;

        @DataMember
        public BigDecimal WeightedCost = null;

        @DataMember
        public String Notes = null;

        @DataMember
        public ArrayList<InventoryDetailAttribute> Attributes = null;

        @DataMember
        public ArrayList<ImageInfo> Images = null;

        @DataMember
        public Boolean HasImages = null;

        @DataMember
        public Boolean IsActiveeHoldback = null;

        @DataMember
        public Integer CustomerAcct = null;

        @DataMember
        public Boolean AvailableForSTR = null;
        
        public Long getSasPk() { return SasPk; }
        public InventoryDetailBySerial setSasPk(Long value) { this.SasPk = value; return this; }
        public String getSerial() { return Serial; }
        public InventoryDetailBySerial setSerial(String value) { this.Serial = value; return this; }
        public BigDecimal getRetail() { return Retail; }
        public InventoryDetailBySerial setRetail(BigDecimal value) { this.Retail = value; return this; }
        public BigDecimal getOurPrice() { return OurPrice; }
        public InventoryDetailBySerial setOurPrice(BigDecimal value) { this.OurPrice = value; return this; }
        public BigDecimal getSalePrice() { return SalePrice; }
        public InventoryDetailBySerial setSalePrice(BigDecimal value) { this.SalePrice = value; return this; }
        public String getStatus() { return Status; }
        public InventoryDetailBySerial setStatus(String value) { this.Status = value; return this; }
        public String getSaleInfo() { return SaleInfo; }
        public InventoryDetailBySerial setSaleInfo(String value) { this.SaleInfo = value; return this; }
        public BigDecimal getPriceA() { return PriceA; }
        public InventoryDetailBySerial setPriceA(BigDecimal value) { this.PriceA = value; return this; }
        public BigDecimal getPriceB() { return PriceB; }
        public InventoryDetailBySerial setPriceB(BigDecimal value) { this.PriceB = value; return this; }
        public BigDecimal getPriceC() { return PriceC; }
        public InventoryDetailBySerial setPriceC(BigDecimal value) { this.PriceC = value; return this; }
        public BigDecimal getMinPrice() { return MinPrice; }
        public InventoryDetailBySerial setMinPrice(BigDecimal value) { this.MinPrice = value; return this; }
        public BigDecimal getActiveEPrice() { return ActiveEPrice; }
        public InventoryDetailBySerial setActiveEPrice(BigDecimal value) { this.ActiveEPrice = value; return this; }
        public Boolean isAllowPriceChange() { return AllowPriceChange; }
        public InventoryDetailBySerial setAllowPriceChange(Boolean value) { this.AllowPriceChange = value; return this; }
        public BigDecimal getCost() { return Cost; }
        public InventoryDetailBySerial setCost(BigDecimal value) { this.Cost = value; return this; }
        public BigDecimal getWeightedCost() { return WeightedCost; }
        public InventoryDetailBySerial setWeightedCost(BigDecimal value) { this.WeightedCost = value; return this; }
        public String getNotes() { return Notes; }
        public InventoryDetailBySerial setNotes(String value) { this.Notes = value; return this; }
        public ArrayList<InventoryDetailAttribute> getAttributes() { return Attributes; }
        public InventoryDetailBySerial setAttributes(ArrayList<InventoryDetailAttribute> value) { this.Attributes = value; return this; }
        public ArrayList<ImageInfo> getImages() { return Images; }
        public InventoryDetailBySerial setImages(ArrayList<ImageInfo> value) { this.Images = value; return this; }
        public Boolean isHasImages() { return HasImages; }
        public InventoryDetailBySerial setHasImages(Boolean value) { this.HasImages = value; return this; }
        public Boolean getIsActiveeHoldback() { return IsActiveeHoldback; }
        public InventoryDetailBySerial setIsActiveeHoldback(Boolean value) { this.IsActiveeHoldback = value; return this; }
        public Integer getCustomerAcct() { return CustomerAcct; }
        public InventoryDetailBySerial setCustomerAcct(Integer value) { this.CustomerAcct = value; return this; }
        public Boolean isAvailableForSTR() { return AvailableForSTR; }
        public InventoryDetailBySerial setAvailableForSTR(Boolean value) { this.AvailableForSTR = value; return this; }
    }

    @DataContract
    public static class InventoryDetailAttribute
    {
        @DataMember
        public String Name = null;

        @DataMember
        public String Value = null;

        @DataMember
        public Integer Priority = 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")
        public Integer WebType = null;
        
        public String getName() { return Name; }
        public InventoryDetailAttribute setName(String value) { this.Name = value; return this; }
        public String getValue() { return Value; }
        public InventoryDetailAttribute setValue(String value) { this.Value = value; return this; }
        public Integer getPriority() { return Priority; }
        public InventoryDetailAttribute setPriority(Integer value) { this.Priority = value; return this; }
        public Integer getWebType() { return WebType; }
        public InventoryDetailAttribute setWebType(Integer value) { this.WebType = value; return this; }
    }

    @DataContract
    public static class ImageInfo
    {
        @DataMember
        public String Url = null;

        @DataMember
        public String ImageStream = null;

        @DataMember
        public String ImageSize = null;

        @DataMember
        public String ErrorMessage = null;

        @DataMember
        public Long UriPk = null;
        
        public String getUrl() { return Url; }
        public ImageInfo setUrl(String value) { this.Url = value; return this; }
        public String getImageStream() { return ImageStream; }
        public ImageInfo setImageStream(String value) { this.ImageStream = value; return this; }
        public String getImageSize() { return ImageSize; }
        public ImageInfo setImageSize(String value) { this.ImageSize = value; return this; }
        public String getErrorMessage() { return ErrorMessage; }
        public ImageInfo setErrorMessage(String value) { this.ErrorMessage = value; return this; }
        public Long getUriPk() { return UriPk; }
        public ImageInfo setUriPk(Long value) { this.UriPk = value; return this; }
    }

}

Java SerialDetailRequest DTOs

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>