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
"use strict";
export class BaseRequest {
    /** @param {{ApiKey?:string,OAuthToken?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description This is your AIM API Key provided by Tri-Tech */
    ApiKey;
    /** @type {string} */
    OAuthToken;
}
export class BaseSecureRequest extends BaseRequest {
    /** @param {{Token?:string,DeviceId?:string,AppId?:string,ApiKey?:string,OAuthToken?:string}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {string} */
    Token;
    /** @type {string} */
    DeviceId;
    /** @type {string} */
    AppId;
}
export class BaseResponseResult {
    /** @param {{StatusCode?:string,Login?:string,ErrorCode?:string,ErrorDisplayText?:string,ErrorMessage?:string,DomainName?:string,IpAddress?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    StatusCode;
    /** @type {string} */
    Login;
    /** @type {string} */
    ErrorCode;
    /** @type {string} */
    ErrorDisplayText;
    /** @type {string} */
    ErrorMessage;
    /** @type {string} */
    DomainName;
    /** @type {string} */
    IpAddress;
}
export class BaseResponse {
    /** @param {{Status?:BaseResponseResult}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {BaseResponseResult} */
    Status;
}
export class InventoryLookupObj {
    /** @param {{ResultType?:string,Sku?:string,Serial?:string,Category?:number,SubCategory?:number,Description?:string,ComputerQty?:number,AvailableQty?:number,SadPk?:number,SkuPk?:number,SasPk?:number,InventoryType?:string,NicsPrice?:number,ADBookItem?:boolean,LocationCode?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    ResultType;
    /** @type {string} */
    Sku;
    /** @type {string} */
    Serial;
    /** @type {number} */
    Category;
    /** @type {number} */
    SubCategory;
    /** @type {string} */
    Description;
    /** @type {number} */
    ComputerQty;
    /** @type {number} */
    AvailableQty;
    /** @type {number} */
    SadPk;
    /** @type {number} */
    SkuPk;
    /** @type {?number} */
    SasPk;
    /** @type {string} */
    InventoryType;
    /** @type {?number} */
    NicsPrice;
    /** @type {boolean} */
    ADBookItem;
    /** @type {string} */
    LocationCode;
}
export class InventoryLookupResponse extends BaseResponse {
    /** @param {{Results?:InventoryLookupObj[],Status?:BaseResponseResult}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {InventoryLookupObj[]} */
    Results;
}
export class InventoryLookupRequest extends BaseSecureRequest {
    /** @param {{Item?:string,LocationCode?:string,Token?:string,DeviceId?:string,AppId?:string,ApiKey?:string,OAuthToken?:string}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {string} */
    Item;
    /** @type {string} */
    LocationCode;
}

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

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

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

{"Results":[{"ResultType":"String","Sku":"String","Serial":"String","Category":0,"SubCategory":0,"Description":"String","ComputerQty":0,"AvailableQty":0,"SadPk":0,"SkuPk":0,"SasPk":0,"InventoryType":"String","NicsPrice":0,"ADBookItem":false,"LocationCode":"String"}],"Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}