AIM Web Services

<back to all web services

InventoryLookupRequest

InventoryLookup
Requires active-e Inventory Service

The following routes are available for this service:
GET/api/InventoryLookup
import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    /**
    * InventoryLookupRequires active-e Inventory Service
    */
    @DataContract
    public static class InventoryLookupRequest extends BaseSecureRequest
    {
        @DataMember
        public String Item = null;

        @DataMember
        public String LocationCode = null;
        
        public String getItem() { return Item; }
        public InventoryLookupRequest setItem(String value) { this.Item = value; return this; }
        public String getLocationCode() { return LocationCode; }
        public InventoryLookupRequest setLocationCode(String value) { this.LocationCode = value; return this; }
    }

    @DataContract
    public static class BaseSecureRequest extends BaseRequest
    {
        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="string", Description="", Name="Token", ParameterType="Header")
        public String Token = null;

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

        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="string", Description="", IsRequired=true, Name="AppId", ParameterType="Header")
        public String AppId = null;
        
        public String getToken() { return Token; }
        public BaseSecureRequest setToken(String value) { this.Token = value; return this; }
        public String getDeviceId() { return DeviceId; }
        public BaseSecureRequest setDeviceId(String value) { this.DeviceId = value; return this; }
        public String getAppId() { return AppId; }
        public BaseSecureRequest setAppId(String value) { this.AppId = 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;

        @DataMember
        @ApiMember(DataType="string", Name="OAuthToken", ParameterType="header")
        public String OAuthToken = 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; }
    }

    @DataContract
    public static class InventoryLookupResponse extends BaseResponse
    {
        @DataMember
        public ArrayList<InventoryLookupObj> Results = null;
        
        public ArrayList<InventoryLookupObj> getResults() { return Results; }
        public InventoryLookupResponse setResults(ArrayList<InventoryLookupObj> value) { this.Results = 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 InventoryLookupObj
    {
        @DataMember
        public String ResultType = null;

        @DataMember
        public String Sku = null;

        @DataMember
        public String Serial = null;

        @DataMember
        public Integer Category = null;

        @DataMember
        public Integer SubCategory = null;

        @DataMember
        public String Description = null;

        @DataMember
        public BigDecimal ComputerQty = null;

        @DataMember
        public BigDecimal AvailableQty = null;

        @DataMember
        public Long SadPk = null;

        @DataMember
        public Long SkuPk = null;

        @DataMember
        public Long SasPk = null;

        @DataMember
        public String InventoryType = null;

        @DataMember
        public BigDecimal NicsPrice = null;

        @DataMember
        public Boolean ADBookItem = null;

        @DataMember
        public String LocationCode = null;
        
        public String getResultType() { return ResultType; }
        public InventoryLookupObj setResultType(String value) { this.ResultType = value; return this; }
        public String getSku() { return Sku; }
        public InventoryLookupObj setSku(String value) { this.Sku = value; return this; }
        public String getSerial() { return Serial; }
        public InventoryLookupObj setSerial(String value) { this.Serial = value; return this; }
        public Integer getCategory() { return Category; }
        public InventoryLookupObj setCategory(Integer value) { this.Category = value; return this; }
        public Integer getSubCategory() { return SubCategory; }
        public InventoryLookupObj setSubCategory(Integer value) { this.SubCategory = value; return this; }
        public String getDescription() { return Description; }
        public InventoryLookupObj setDescription(String value) { this.Description = value; return this; }
        public BigDecimal getComputerQty() { return ComputerQty; }
        public InventoryLookupObj setComputerQty(BigDecimal value) { this.ComputerQty = value; return this; }
        public BigDecimal getAvailableQty() { return AvailableQty; }
        public InventoryLookupObj setAvailableQty(BigDecimal value) { this.AvailableQty = value; return this; }
        public Long getSadPk() { return SadPk; }
        public InventoryLookupObj setSadPk(Long value) { this.SadPk = value; return this; }
        public Long getSkuPk() { return SkuPk; }
        public InventoryLookupObj setSkuPk(Long value) { this.SkuPk = value; return this; }
        public Long getSasPk() { return SasPk; }
        public InventoryLookupObj setSasPk(Long value) { this.SasPk = value; return this; }
        public String getInventoryType() { return InventoryType; }
        public InventoryLookupObj setInventoryType(String value) { this.InventoryType = value; return this; }
        public BigDecimal getNicsPrice() { return NicsPrice; }
        public InventoryLookupObj setNicsPrice(BigDecimal value) { this.NicsPrice = value; return this; }
        public Boolean isAdBookItem() { return ADBookItem; }
        public InventoryLookupObj setAdBookItem(Boolean value) { this.ADBookItem = value; return this; }
        public String getLocationCode() { return LocationCode; }
        public InventoryLookupObj setLocationCode(String value) { this.LocationCode = value; return this; }
    }

}

Java InventoryLookupRequest 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.

GET /api/InventoryLookup HTTP/1.1 
Host: active-ewebservice.biz 
Accept: application/xml

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

<InventoryLookupResponse 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>
  <Results>
    <InventoryLookupObj>
      <ADBookItem>false</ADBookItem>
      <AvailableQty>0</AvailableQty>
      <Category>0</Category>
      <ComputerQty>0</ComputerQty>
      <Description>String</Description>
      <InventoryType>String</InventoryType>
      <LocationCode>String</LocationCode>
      <NicsPrice>0</NicsPrice>
      <ResultType>String</ResultType>
      <SadPk>0</SadPk>
      <SasPk>0</SasPk>
      <Serial>String</Serial>
      <Sku>String</Sku>
      <SkuPk>0</SkuPk>
      <SubCategory>0</SubCategory>
    </InventoryLookupObj>
  </Results>
</InventoryLookupResponse>