| GET | /api/ScheduledExchanges |
|---|
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 ScheduledExchangesGetInfo implements IConvertible
{
// @DataMember
int? ExchangeID;
// @DataMember
int? Acct;
// @DataMember
int? Sub;
// @DataMember
String? Name;
// @DataMember
String? Address;
// @DataMember
String? Address2;
// @DataMember
String? City;
// @DataMember
String? Student;
// @DataMember
String? School;
// @DataMember
String? District;
// @DataMember
String? Item;
// @DataMember
String? Employee;
// @DataMember
DateTime? ReturnedDate;
// @DataMember
String? StockNumber;
// @DataMember
String? Serial;
// @DataMember
String? ReturnOption;
// @DataMember
String? ScheduledReturnedRef;
// @DataMember
String? Status;
// @DataMember
String? History;
// @DataMember
int? ExchangeRef;
// @DataMember
DateTime? AutoPayHoldDate;
// @DataMember
String? ExchangedItem;
// @DataMember
DateTime? PostingDate;
// @DataMember
DateTime? ScheduledDate;
// @DataMember
String? NewSku;
// @DataMember
String? Notes;
// @DataMember
String? Source;
// @DataMember
String? Option;
// @DataMember
bool? Processed;
// @DataMember
bool? MobileExchangedStatus;
ScheduledExchangesGetInfo({this.ExchangeID,this.Acct,this.Sub,this.Name,this.Address,this.Address2,this.City,this.Student,this.School,this.District,this.Item,this.Employee,this.ReturnedDate,this.StockNumber,this.Serial,this.ReturnOption,this.ScheduledReturnedRef,this.Status,this.History,this.ExchangeRef,this.AutoPayHoldDate,this.ExchangedItem,this.PostingDate,this.ScheduledDate,this.NewSku,this.Notes,this.Source,this.Option,this.Processed,this.MobileExchangedStatus});
ScheduledExchangesGetInfo.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
ExchangeID = json['ExchangeID'];
Acct = json['Acct'];
Sub = json['Sub'];
Name = json['Name'];
Address = json['Address'];
Address2 = json['Address2'];
City = json['City'];
Student = json['Student'];
School = json['School'];
District = json['District'];
Item = json['Item'];
Employee = json['Employee'];
ReturnedDate = JsonConverters.fromJson(json['ReturnedDate'],'DateTime',context!);
StockNumber = json['StockNumber'];
Serial = json['Serial'];
ReturnOption = json['ReturnOption'];
ScheduledReturnedRef = json['ScheduledReturnedRef'];
Status = json['Status'];
History = json['History'];
ExchangeRef = json['ExchangeRef'];
AutoPayHoldDate = JsonConverters.fromJson(json['AutoPayHoldDate'],'DateTime',context!);
ExchangedItem = json['ExchangedItem'];
PostingDate = JsonConverters.fromJson(json['PostingDate'],'DateTime',context!);
ScheduledDate = JsonConverters.fromJson(json['ScheduledDate'],'DateTime',context!);
NewSku = json['NewSku'];
Notes = json['Notes'];
Source = json['Source'];
Option = json['Option'];
Processed = json['Processed'];
MobileExchangedStatus = json['MobileExchangedStatus'];
return this;
}
Map<String, dynamic> toJson() => {
'ExchangeID': ExchangeID,
'Acct': Acct,
'Sub': Sub,
'Name': Name,
'Address': Address,
'Address2': Address2,
'City': City,
'Student': Student,
'School': School,
'District': District,
'Item': Item,
'Employee': Employee,
'ReturnedDate': JsonConverters.toJson(ReturnedDate,'DateTime',context!),
'StockNumber': StockNumber,
'Serial': Serial,
'ReturnOption': ReturnOption,
'ScheduledReturnedRef': ScheduledReturnedRef,
'Status': Status,
'History': History,
'ExchangeRef': ExchangeRef,
'AutoPayHoldDate': JsonConverters.toJson(AutoPayHoldDate,'DateTime',context!),
'ExchangedItem': ExchangedItem,
'PostingDate': JsonConverters.toJson(PostingDate,'DateTime',context!),
'ScheduledDate': JsonConverters.toJson(ScheduledDate,'DateTime',context!),
'NewSku': NewSku,
'Notes': Notes,
'Source': Source,
'Option': Option,
'Processed': Processed,
'MobileExchangedStatus': MobileExchangedStatus
};
getTypeName() => "ScheduledExchangesGetInfo";
TypeContext? context = _ctx;
}
// @DataContract
class ScheduledExchangesGetResponse extends BaseResponse implements IConvertible
{
// @DataMember
List<ScheduledExchangesGetInfo>? ScheduledExchanges;
ScheduledExchangesGetResponse({this.ScheduledExchanges});
ScheduledExchangesGetResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
super.fromMap(json);
ScheduledExchanges = JsonConverters.fromJson(json['ScheduledExchanges'],'List<ScheduledExchangesGetInfo>',context!);
return this;
}
Map<String, dynamic> toJson() => super.toJson()..addAll({
'ScheduledExchanges': JsonConverters.toJson(ScheduledExchanges,'List<ScheduledExchangesGetInfo>',context!)
});
getTypeName() => "ScheduledExchangesGetResponse";
TypeContext? context = _ctx;
}
/**
* ScheduledExchangesRequires active-e Contracts Service.
*/
// @DataContract
class ScheduledExchangesGetRequest extends BaseSecureRequest implements IConvertible
{
// @DataMember
DateTime? ScheduledDateFrom;
// @DataMember
DateTime? ScheduledDateTo;
// @DataMember
int? DistrictId;
// @DataMember
int? SchoolId;
// @DataMember
int? LocationId;
// @DataMember
int? StatusId;
// @DataMember
int? OptionId;
// @DataMember
bool? IncludeProcessed;
// @DataMember
String? LanId;
ScheduledExchangesGetRequest({this.ScheduledDateFrom,this.ScheduledDateTo,this.DistrictId,this.SchoolId,this.LocationId,this.StatusId,this.OptionId,this.IncludeProcessed,this.LanId});
ScheduledExchangesGetRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
super.fromMap(json);
ScheduledDateFrom = JsonConverters.fromJson(json['ScheduledDateFrom'],'DateTime',context!);
ScheduledDateTo = JsonConverters.fromJson(json['ScheduledDateTo'],'DateTime',context!);
DistrictId = json['DistrictId'];
SchoolId = json['SchoolId'];
LocationId = json['LocationId'];
StatusId = json['StatusId'];
OptionId = json['OptionId'];
IncludeProcessed = json['IncludeProcessed'];
LanId = json['LanId'];
return this;
}
Map<String, dynamic> toJson() => super.toJson()..addAll({
'ScheduledDateFrom': JsonConverters.toJson(ScheduledDateFrom,'DateTime',context!),
'ScheduledDateTo': JsonConverters.toJson(ScheduledDateTo,'DateTime',context!),
'DistrictId': DistrictId,
'SchoolId': SchoolId,
'LocationId': LocationId,
'StatusId': StatusId,
'OptionId': OptionId,
'IncludeProcessed': IncludeProcessed,
'LanId': LanId
});
getTypeName() => "ScheduledExchangesGetRequest";
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()),
'ScheduledExchangesGetInfo': TypeInfo(TypeOf.Class, create:() => ScheduledExchangesGetInfo()),
'ScheduledExchangesGetResponse': TypeInfo(TypeOf.Class, create:() => ScheduledExchangesGetResponse()),
'List<ScheduledExchangesGetInfo>': TypeInfo(TypeOf.Class, create:() => <ScheduledExchangesGetInfo>[]),
'ScheduledExchangesGetRequest': TypeInfo(TypeOf.Class, create:() => ScheduledExchangesGetRequest()),
});
Dart ScheduledExchangesGetRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /api/ScheduledExchanges HTTP/1.1 Host: active-ewebservice.biz Accept: text/jsonl
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length
{"ScheduledExchanges":[{"ExchangeID":0,"Acct":0,"Sub":0,"Name":"String","Address":"String","Address2":"String","City":"String","Student":"String","School":"String","District":"String","Item":"String","Employee":"String","ReturnedDate":"0001-01-01T00:00:00.0000000","StockNumber":"String","Serial":"String","ReturnOption":"String","ScheduledReturnedRef":"String","Status":"String","History":"String","ExchangeRef":0,"AutoPayHoldDate":"0001-01-01T00:00:00.0000000","ExchangedItem":"String","NewSku":"String","Notes":"String","Source":"String","Option":"String","Processed":false,"MobileExchangedStatus":false}],"Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}