AIM Web Services

<back to all web services

ScanForImportRequest

ScanForImport
Requires active-e Inventory Service

The following routes are available for this service:
POST/api/ScanForImport
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 ExceptionInfo implements IConvertible
{
    // @DataMember
    String? Barcode;

    // @DataMember
    String? Description;

    // @DataMember
    String? Base64Image;

    // @DataMember
    int? Category;

    // @DataMember
    int? SubCategory;

    ExceptionInfo({this.Barcode,this.Description,this.Base64Image,this.Category,this.SubCategory});
    ExceptionInfo.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Barcode = json['Barcode'];
        Description = json['Description'];
        Base64Image = json['Base64Image'];
        Category = json['Category'];
        SubCategory = json['SubCategory'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Barcode': Barcode,
        'Description': Description,
        'Base64Image': Base64Image,
        'Category': Category,
        'SubCategory': SubCategory
    };

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

// @DataContract
class ScanErrorItem implements IScanItem, IConvertible
{
    // @DataMember
    int? SkuPk;

    // @DataMember
    int? SasPk;

    // @DataMember
    String? Sku;

    // @DataMember
    String? Serial;

    // @DataMember
    double? Quantity;

    // @DataMember
    ExceptionInfo? ExceptionInfo;

    // @DataMember
    String? ErrorMessage;

    ScanErrorItem({this.SkuPk,this.SasPk,this.Sku,this.Serial,this.Quantity,this.ExceptionInfo,this.ErrorMessage});
    ScanErrorItem.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        SkuPk = json['SkuPk'];
        SasPk = json['SasPk'];
        Sku = json['Sku'];
        Serial = json['Serial'];
        Quantity = JsonConverters.toDouble(json['Quantity']);
        ExceptionInfo = JsonConverters.fromJson(json['ExceptionInfo'],'ExceptionInfo',context!);
        ErrorMessage = json['ErrorMessage'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'SkuPk': SkuPk,
        'SasPk': SasPk,
        'Sku': Sku,
        'Serial': Serial,
        'Quantity': Quantity,
        'ExceptionInfo': JsonConverters.toJson(ExceptionInfo,'ExceptionInfo',context!),
        'ErrorMessage': ErrorMessage
    };

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

// @DataContract
class ScanForImportResponse extends BaseResponse implements IConvertible
{
    // @DataMember
    List<ScanErrorItem>? ErrorItems;

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

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

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

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

// @DataContract
class ScanItem implements IScanItem, IConvertible
{
    // @DataMember
    int? SkuPk;

    // @DataMember
    int? SasPk;

    // @DataMember
    String? Sku;

    // @DataMember
    String? Serial;

    // @DataMember
    double? Quantity;

    // @DataMember
    ExceptionInfo? ExceptionInfo;

    ScanItem({this.SkuPk,this.SasPk,this.Sku,this.Serial,this.Quantity,this.ExceptionInfo});
    ScanItem.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        SkuPk = json['SkuPk'];
        SasPk = json['SasPk'];
        Sku = json['Sku'];
        Serial = json['Serial'];
        Quantity = JsonConverters.toDouble(json['Quantity']);
        ExceptionInfo = JsonConverters.fromJson(json['ExceptionInfo'],'ExceptionInfo',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'SkuPk': SkuPk,
        'SasPk': SasPk,
        'Sku': Sku,
        'Serial': Serial,
        'Quantity': Quantity,
        'ExceptionInfo': JsonConverters.toJson(ExceptionInfo,'ExceptionInfo',context!)
    };

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

/**
* ScanForImportRequires active-e Inventory Service
*/
// @DataContract
class ScanForImportRequest extends BaseSecureRequest implements IConvertible
{
    // @DataMember
    String? Description;

    // @DataMember
    List<ScanItem>? Items;

    // @DataMember
    bool? ReceiveInventoryMode;

    // @DataMember
    bool? AppendMode;

    ScanForImportRequest({this.Description,this.Items,this.ReceiveInventoryMode,this.AppendMode});
    ScanForImportRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        Description = json['Description'];
        Items = JsonConverters.fromJson(json['Items'],'List<ScanItem>',context!);
        ReceiveInventoryMode = json['ReceiveInventoryMode'];
        AppendMode = json['AppendMode'];
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson()..addAll({
        'Description': Description,
        'Items': JsonConverters.toJson(Items,'List<ScanItem>',context!),
        'ReceiveInventoryMode': ReceiveInventoryMode,
        'AppendMode': AppendMode
    });

    getTypeName() => "ScanForImportRequest";
    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()),
    'ExceptionInfo': TypeInfo(TypeOf.Class, create:() => ExceptionInfo()),
    'ScanErrorItem': TypeInfo(TypeOf.Class, create:() => ScanErrorItem()),
    'ScanForImportResponse': TypeInfo(TypeOf.Class, create:() => ScanForImportResponse()),
    'List<ScanErrorItem>': TypeInfo(TypeOf.Class, create:() => <ScanErrorItem>[]),
    'ScanItem': TypeInfo(TypeOf.Class, create:() => ScanItem()),
    'ScanForImportRequest': TypeInfo(TypeOf.Class, create:() => ScanForImportRequest()),
    'List<ScanItem>': TypeInfo(TypeOf.Class, create:() => <ScanItem>[]),
});

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

POST /api/ScanForImport HTTP/1.1 
Host: active-ewebservice.biz 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<ScanForImportRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AIM.WebService">
  <ApiKey>String</ApiKey>
  <OAuthToken>String</OAuthToken>
  <AppId>String</AppId>
  <DeviceId>String</DeviceId>
  <Token>String</Token>
  <AppendMode>false</AppendMode>
  <Description>String</Description>
  <Items xmlns:d2p1="http://schemas.datacontract.org/2004/07/AIM">
    <d2p1:ScanItem>
      <d2p1:ExceptionInfo>
        <d2p1:Barcode>String</d2p1:Barcode>
        <d2p1:Base64Image>String</d2p1:Base64Image>
        <d2p1:Category>0</d2p1:Category>
        <d2p1:Description>String</d2p1:Description>
        <d2p1:SubCategory>0</d2p1:SubCategory>
      </d2p1:ExceptionInfo>
      <d2p1:Quantity>0</d2p1:Quantity>
      <d2p1:SasPk>0</d2p1:SasPk>
      <d2p1:Serial>String</d2p1:Serial>
      <d2p1:Sku>String</d2p1:Sku>
      <d2p1:SkuPk>0</d2p1:SkuPk>
    </d2p1:ScanItem>
  </Items>
  <ReceiveInventoryMode>false</ReceiveInventoryMode>
</ScanForImportRequest>

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

<ScanForImportResponse 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>
  <ErrorItems xmlns:d2p1="http://schemas.datacontract.org/2004/07/AIM">
    <d2p1:ScanErrorItem>
      <d2p1:ErrorMessage>String</d2p1:ErrorMessage>
      <d2p1:ExceptionInfo>
        <d2p1:Barcode>String</d2p1:Barcode>
        <d2p1:Base64Image>String</d2p1:Base64Image>
        <d2p1:Category>0</d2p1:Category>
        <d2p1:Description>String</d2p1:Description>
        <d2p1:SubCategory>0</d2p1:SubCategory>
      </d2p1:ExceptionInfo>
      <d2p1:Quantity>0</d2p1:Quantity>
      <d2p1:SasPk>0</d2p1:SasPk>
      <d2p1:Serial>String</d2p1:Serial>
      <d2p1:Sku>String</d2p1:Sku>
      <d2p1:SkuPk>0</d2p1:SkuPk>
    </d2p1:ScanErrorItem>
  </ErrorItems>
</ScanForImportResponse>