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 'package:servicestack/servicestack.dart';

// @DataContract
class BaseRequest implements IConvertible
{
    /**
    * 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")
    String? ApiKey;

    // @DataMember
    // @ApiMember(DataType="string", Name="OAuthToken", ParameterType="header")
    String? OAuthToken;

    BaseRequest({this.ApiKey,this.OAuthToken});
    BaseRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        ApiKey = json['ApiKey'];
        OAuthToken = json['OAuthToken'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'ApiKey': ApiKey,
        'OAuthToken': OAuthToken
    };

    getTypeName() => "BaseRequest";
    TypeContext? context = _ctx;
}

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

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

    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="", IsRequired=true, Name="AppId", ParameterType="Header")
    String? AppId;

    BaseSecureRequest({this.Token,this.DeviceId,this.AppId});
    BaseSecureRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        Token = json['Token'];
        DeviceId = json['DeviceId'];
        AppId = json['AppId'];
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson()..addAll({
        'Token': Token,
        'DeviceId': DeviceId,
        'AppId': AppId
    });

    getTypeName() => "BaseSecureRequest";
    TypeContext? context = _ctx;
}

// @DataContract
class BaseResponseResult implements IConvertible
{
    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="StatusCode", ParameterType="body")
    String? StatusCode;

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

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

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

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

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

    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")
    String? IpAddress;

    BaseResponseResult({this.StatusCode,this.Login,this.ErrorCode,this.ErrorDisplayText,this.ErrorMessage,this.DomainName,this.IpAddress});
    BaseResponseResult.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        StatusCode = json['StatusCode'];
        Login = json['Login'];
        ErrorCode = json['ErrorCode'];
        ErrorDisplayText = json['ErrorDisplayText'];
        ErrorMessage = json['ErrorMessage'];
        DomainName = json['DomainName'];
        IpAddress = json['IpAddress'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'StatusCode': StatusCode,
        'Login': Login,
        'ErrorCode': ErrorCode,
        'ErrorDisplayText': ErrorDisplayText,
        'ErrorMessage': ErrorMessage,
        'DomainName': DomainName,
        'IpAddress': IpAddress
    };

    getTypeName() => "BaseResponseResult";
    TypeContext? context = _ctx;
}

// @DataContract
class BaseResponse implements IConvertible
{
    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")
    BaseResponseResult? Status;

    BaseResponse({this.Status});
    BaseResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Status = JsonConverters.fromJson(json['Status'],'BaseResponseResult',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Status': JsonConverters.toJson(Status,'BaseResponseResult',context!)
    };

    getTypeName() => "BaseResponse";
    TypeContext? context = _ctx;
}

// @DataContract
class InventoryLookupObj implements IConvertible
{
    // @DataMember
    String? ResultType;

    // @DataMember
    String? Sku;

    // @DataMember
    String? Serial;

    // @DataMember
    int? Category;

    // @DataMember
    int? SubCategory;

    // @DataMember
    String? Description;

    // @DataMember
    double? ComputerQty;

    // @DataMember
    double? AvailableQty;

    // @DataMember
    int? SadPk;

    // @DataMember
    int? SkuPk;

    // @DataMember
    int? SasPk;

    // @DataMember
    String? InventoryType;

    // @DataMember
    double? NicsPrice;

    // @DataMember
    bool? ADBookItem;

    // @DataMember
    String? LocationCode;

    InventoryLookupObj({this.ResultType,this.Sku,this.Serial,this.Category,this.SubCategory,this.Description,this.ComputerQty,this.AvailableQty,this.SadPk,this.SkuPk,this.SasPk,this.InventoryType,this.NicsPrice,this.ADBookItem,this.LocationCode});
    InventoryLookupObj.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        ResultType = json['ResultType'];
        Sku = json['Sku'];
        Serial = json['Serial'];
        Category = json['Category'];
        SubCategory = json['SubCategory'];
        Description = json['Description'];
        ComputerQty = JsonConverters.toDouble(json['ComputerQty']);
        AvailableQty = JsonConverters.toDouble(json['AvailableQty']);
        SadPk = json['SadPk'];
        SkuPk = json['SkuPk'];
        SasPk = json['SasPk'];
        InventoryType = json['InventoryType'];
        NicsPrice = JsonConverters.toDouble(json['NicsPrice']);
        ADBookItem = json['ADBookItem'];
        LocationCode = json['LocationCode'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'ResultType': ResultType,
        'Sku': Sku,
        'Serial': Serial,
        'Category': Category,
        'SubCategory': SubCategory,
        'Description': Description,
        'ComputerQty': ComputerQty,
        'AvailableQty': AvailableQty,
        'SadPk': SadPk,
        'SkuPk': SkuPk,
        'SasPk': SasPk,
        'InventoryType': InventoryType,
        'NicsPrice': NicsPrice,
        'ADBookItem': ADBookItem,
        'LocationCode': LocationCode
    };

    getTypeName() => "InventoryLookupObj";
    TypeContext? context = _ctx;
}

// @DataContract
class InventoryLookupResponse extends BaseResponse implements IConvertible
{
    // @DataMember
    List<InventoryLookupObj>? Results;

    InventoryLookupResponse({this.Results});
    InventoryLookupResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        Results = JsonConverters.fromJson(json['Results'],'List<InventoryLookupObj>',context!);
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson()..addAll({
        'Results': JsonConverters.toJson(Results,'List<InventoryLookupObj>',context!)
    });

    getTypeName() => "InventoryLookupResponse";
    TypeContext? context = _ctx;
}

/**
* InventoryLookupRequires active-e Inventory Service
*/
// @DataContract
class InventoryLookupRequest extends BaseSecureRequest implements IConvertible
{
    // @DataMember
    String? Item;

    // @DataMember
    String? LocationCode;

    InventoryLookupRequest({this.Item,this.LocationCode});
    InventoryLookupRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        Item = json['Item'];
        LocationCode = json['LocationCode'];
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson()..addAll({
        'Item': Item,
        'LocationCode': LocationCode
    });

    getTypeName() => "InventoryLookupRequest";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'active_ewebservice.biz', types: <String, TypeInfo> {
    'BaseRequest': TypeInfo(TypeOf.Class, create:() => BaseRequest()),
    'BaseSecureRequest': TypeInfo(TypeOf.Class, create:() => BaseSecureRequest()),
    'BaseResponseResult': TypeInfo(TypeOf.Class, create:() => BaseResponseResult()),
    'BaseResponse': TypeInfo(TypeOf.Class, create:() => BaseResponse()),
    'InventoryLookupObj': TypeInfo(TypeOf.Class, create:() => InventoryLookupObj()),
    'InventoryLookupResponse': TypeInfo(TypeOf.Class, create:() => InventoryLookupResponse()),
    'List<InventoryLookupObj>': TypeInfo(TypeOf.Class, create:() => <InventoryLookupObj>[]),
    'InventoryLookupRequest': TypeInfo(TypeOf.Class, create:() => InventoryLookupRequest()),
});

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