| GET | /api/OpenStoreToStoreTransfers |
|---|
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 OpenStoreToStoreTransfersResponse extends BaseResponse implements IConvertible
{
// @DataMember
List<Transfer>? Transfers;
OpenStoreToStoreTransfersResponse({this.Transfers});
OpenStoreToStoreTransfersResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
super.fromMap(json);
Transfers = JsonConverters.fromJson(json['Transfers'],'List<Transfer>',context!);
return this;
}
Map<String, dynamic> toJson() => super.toJson()..addAll({
'Transfers': JsonConverters.toJson(Transfers,'List<Transfer>',context!)
});
getTypeName() => "OpenStoreToStoreTransfersResponse";
TypeContext? context = _ctx;
}
/**
* OpenStoreToStoreTransfersRequires active-e Inventory Service
*/
// @DataContract
class OpenStoreToStoreTransfersRequest extends BaseSecureRequest implements IConvertible
{
/**
* If sent, only transfers to the given location will be returned. Defaults to all locations.
*/
// @DataMember
// @ApiMember(DataType="integer", Description="If sent, only transfers to the given location will be returned. Defaults to all locations.", Format="int64", Name="ToLocationId", ParameterType="query")
int? ToLocationId;
/**
* If sent, only transfers from the given location will be returned. Defaults to all locations.
*/
// @DataMember
// @ApiMember(DataType="integer", Description="If sent, only transfers from the given location will be returned. Defaults to all locations.", Format="int64", Name="FromLocationId", ParameterType="query")
int? FromLocationId;
/**
* Valid values are Ready and Request. Defaults to Ready. Ready returns transfers ready to receive. Request returns transfer requests.
*/
// @DataMember
// @ApiMember(DataType="string", Description="Valid values are Ready and Request. Defaults to Ready. Ready returns transfers ready to receive. Request returns transfer requests.", Name="Mode", ParameterType="query")
String? Mode;
// @DataMember
bool? IncludeCompleted;
OpenStoreToStoreTransfersRequest({this.ToLocationId,this.FromLocationId,this.Mode,this.IncludeCompleted});
OpenStoreToStoreTransfersRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
super.fromMap(json);
ToLocationId = json['ToLocationId'];
FromLocationId = json['FromLocationId'];
Mode = json['Mode'];
IncludeCompleted = json['IncludeCompleted'];
return this;
}
Map<String, dynamic> toJson() => super.toJson()..addAll({
'ToLocationId': ToLocationId,
'FromLocationId': FromLocationId,
'Mode': Mode,
'IncludeCompleted': IncludeCompleted
});
getTypeName() => "OpenStoreToStoreTransfersRequest";
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()),
'OpenStoreToStoreTransfersResponse': TypeInfo(TypeOf.Class, create:() => OpenStoreToStoreTransfersResponse()),
'List<Transfer>': TypeInfo(TypeOf.Class, create:() => <Transfer>[]),
'OpenStoreToStoreTransfersRequest': TypeInfo(TypeOf.Class, create:() => OpenStoreToStoreTransfersRequest()),
});
Dart OpenStoreToStoreTransfersRequest 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
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /api/OpenStoreToStoreTransfers HTTP/1.1 Host: active-ewebservice.biz Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"Transfers":[{"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}],"Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}