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.*


/**
* InventoryLookupRequires active-e Inventory Service
*/
@DataContract
open class InventoryLookupRequest : BaseSecureRequest()
{
    @DataMember
    var Item:String? = null

    @DataMember
    var LocationCode:String? = 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 InventoryLookupResponse : BaseResponse()
{
    @DataMember
    var Results:ArrayList<InventoryLookupObj> = ArrayList<InventoryLookupObj>()
}

@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 InventoryLookupObj
{
    @DataMember
    var ResultType:String? = null

    @DataMember
    var Sku:String? = null

    @DataMember
    var Serial:String? = null

    @DataMember
    var Category:Int? = null

    @DataMember
    var SubCategory:Int? = null

    @DataMember
    var Description:String? = null

    @DataMember
    var ComputerQty:BigDecimal? = null

    @DataMember
    var AvailableQty:BigDecimal? = null

    @DataMember
    var SadPk:Long? = null

    @DataMember
    var SkuPk:Long? = null

    @DataMember
    var SasPk:Long? = null

    @DataMember
    var InventoryType:String? = null

    @DataMember
    var NicsPrice:BigDecimal? = null

    @DataMember
    var ADBookItem:Boolean? = null

    @DataMember
    var LocationCode:String? = null
}

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