AIM Web Services

<back to all web services

TransferDetailsRequest

TransferDetails
Requires active-e Inventory Service

The following routes are available for this service:
GET/api/TransferDetails
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 LocationInfo implements IConvertible
{
    // @DataMember
    int? Id;

    // @DataMember
    String? Desc;

    // @DataMember
    String? ShortDesc;

    // @DataMember
    String? Region;

    // @DataMember
    double? Latitude;

    // @DataMember
    double? Longitude;

    // @DataMember
    String? InStorePickup;

    // @DataMember
    bool? Active;

    // @DataMember
    int? CashSaleAcct;

    LocationInfo({this.Id,this.Desc,this.ShortDesc,this.Region,this.Latitude,this.Longitude,this.InStorePickup,this.Active,this.CashSaleAcct});
    LocationInfo.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Id = json['Id'];
        Desc = json['Desc'];
        ShortDesc = json['ShortDesc'];
        Region = json['Region'];
        Latitude = JsonConverters.toDouble(json['Latitude']);
        Longitude = JsonConverters.toDouble(json['Longitude']);
        InStorePickup = json['InStorePickup'];
        Active = json['Active'];
        CashSaleAcct = json['CashSaleAcct'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Id': Id,
        'Desc': Desc,
        'ShortDesc': ShortDesc,
        'Region': Region,
        'Latitude': Latitude,
        'Longitude': Longitude,
        'InStorePickup': InStorePickup,
        'Active': Active,
        'CashSaleAcct': CashSaleAcct
    };

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

// @DataContract
class Transfer implements IConvertible
{
    // @DataMember
    String? RefNumber;

    // @DataMember
    DateTime? DateTime;

    // @DataMember
    LocationInfo? From;

    // @DataMember
    LocationInfo? To;

    // @DataMember
    bool? IsRequest;

    Transfer({this.RefNumber,this.DateTime,this.From,this.To,this.IsRequest});
    Transfer.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        RefNumber = json['RefNumber'];
        DateTime = JsonConverters.fromJson(json['DateTime'],'DateTime',context!);
        From = JsonConverters.fromJson(json['From'],'LocationInfo',context!);
        To = JsonConverters.fromJson(json['To'],'LocationInfo',context!);
        IsRequest = json['IsRequest'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'RefNumber': RefNumber,
        'DateTime': JsonConverters.toJson(DateTime,'DateTime',context!),
        'From': JsonConverters.toJson(From,'LocationInfo',context!),
        'To': JsonConverters.toJson(To,'LocationInfo',context!),
        'IsRequest': IsRequest
    };

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

// @DataContract
class TransferLineItem implements IConvertible
{
    // @DataMember
    double? QtyIn;

    // @DataMember
    double? QtyOut;

    // @DataMember
    String? Sku;

    // @DataMember
    String? Desc;

    // @DataMember
    String? Notes;

    // @DataMember
    bool? OverShipment;

    // @DataMember
    bool? IsADBook;

    // @DataMember
    int? SkuPk;

    // @DataMember
    int? SaqPk;

    // @DataMember
    int? SasPk;

    TransferLineItem({this.QtyIn,this.QtyOut,this.Sku,this.Desc,this.Notes,this.OverShipment,this.IsADBook,this.SkuPk,this.SaqPk,this.SasPk});
    TransferLineItem.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        QtyIn = JsonConverters.toDouble(json['QtyIn']);
        QtyOut = JsonConverters.toDouble(json['QtyOut']);
        Sku = json['Sku'];
        Desc = json['Desc'];
        Notes = json['Notes'];
        OverShipment = json['OverShipment'];
        IsADBook = json['IsADBook'];
        SkuPk = json['SkuPk'];
        SaqPk = json['SaqPk'];
        SasPk = json['SasPk'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'QtyIn': QtyIn,
        'QtyOut': QtyOut,
        'Sku': Sku,
        'Desc': Desc,
        'Notes': Notes,
        'OverShipment': OverShipment,
        'IsADBook': IsADBook,
        'SkuPk': SkuPk,
        'SaqPk': SaqPk,
        'SasPk': SasPk
    };

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

// @DataContract
class TransferDetailsResponse extends BaseResponse implements IConvertible
{
    // @DataMember
    Transfer? TransferInfo;

    // @DataMember
    List<TransferLineItem>? LineItems;

    TransferDetailsResponse({this.TransferInfo,this.LineItems});
    TransferDetailsResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

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

    Map<String, dynamic> toJson() => super.toJson()..addAll({
        'TransferInfo': JsonConverters.toJson(TransferInfo,'Transfer',context!),
        'LineItems': JsonConverters.toJson(LineItems,'List<TransferLineItem>',context!)
    });

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

/**
* TransferDetailsRequires active-e Inventory Service
*/
// @DataContract
class TransferDetailsRequest extends BaseSecureRequest implements IConvertible
{
    // @DataMember
    String? RefNumber;

    /**
    * Valid values are All, FullyTransferred, and NotFullyTransferred. Defaults to NotFullyTransferred.
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="Valid values are All, FullyTransferred, and NotFullyTransferred. Defaults to NotFullyTransferred.", Name="Mode", ParameterType="query")
    String? Mode;

    TransferDetailsRequest({this.RefNumber,this.Mode});
    TransferDetailsRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }

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

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

    getTypeName() => "TransferDetailsRequest";
    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()),
    'LocationInfo': TypeInfo(TypeOf.Class, create:() => LocationInfo()),
    'Transfer': TypeInfo(TypeOf.Class, create:() => Transfer()),
    'TransferLineItem': TypeInfo(TypeOf.Class, create:() => TransferLineItem()),
    'TransferDetailsResponse': TypeInfo(TypeOf.Class, create:() => TransferDetailsResponse()),
    'List<TransferLineItem>': TypeInfo(TypeOf.Class, create:() => <TransferLineItem>[]),
    'TransferDetailsRequest': TypeInfo(TypeOf.Class, create:() => TransferDetailsRequest()),
});

Dart TransferDetailsRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other

HTTP + OTHER

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /api/TransferDetails HTTP/1.1 
Host: active-ewebservice.biz 
Accept: text/jsonl

HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"TransferInfo":{"RefNumber":"String","From":{"Id":0,"Desc":"String","ShortDesc":"String","Region":"String","Latitude":0,"Longitude":0,"InStorePickup":"String","Active":false,"CashSaleAcct":0},"To":{"Id":0,"Desc":"String","ShortDesc":"String","Region":"String","Latitude":0,"Longitude":0,"InStorePickup":"String","Active":false,"CashSaleAcct":0},"IsRequest":false},"LineItems":[{"QtyIn":0,"QtyOut":0,"Sku":"String","Desc":"String","Notes":"String","OverShipment":false,"IsADBook":false,"SkuPk":0,"SaqPk":0,"SasPk":0}],"Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}