| GET | /api/ContractScheduledReturns |
|---|
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 ContractScheduledReturnInfo implements IConvertible
{
// @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
DateTime? ScheduledReturnDate;
// @DataMember
String? StockNumber;
// @DataMember
String? Serial;
// @DataMember
String? ReturnOption;
// @DataMember
String? ScheduledReturnedRef;
// @DataMember
String? Status;
// @DataMember
DateTime? AutoPayHoldDate;
// @DataMember
bool? MobileReturnedStatus;
ContractScheduledReturnInfo({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.ScheduledReturnDate,this.StockNumber,this.Serial,this.ReturnOption,this.ScheduledReturnedRef,this.Status,this.AutoPayHoldDate,this.MobileReturnedStatus});
ContractScheduledReturnInfo.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
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!);
ScheduledReturnDate = JsonConverters.fromJson(json['ScheduledReturnDate'],'DateTime',context!);
StockNumber = json['StockNumber'];
Serial = json['Serial'];
ReturnOption = json['ReturnOption'];
ScheduledReturnedRef = json['ScheduledReturnedRef'];
Status = json['Status'];
AutoPayHoldDate = JsonConverters.fromJson(json['AutoPayHoldDate'],'DateTime',context!);
MobileReturnedStatus = json['MobileReturnedStatus'];
return this;
}
Map<String, dynamic> toJson() => {
'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!),
'ScheduledReturnDate': JsonConverters.toJson(ScheduledReturnDate,'DateTime',context!),
'StockNumber': StockNumber,
'Serial': Serial,
'ReturnOption': ReturnOption,
'ScheduledReturnedRef': ScheduledReturnedRef,
'Status': Status,
'AutoPayHoldDate': JsonConverters.toJson(AutoPayHoldDate,'DateTime',context!),
'MobileReturnedStatus': MobileReturnedStatus
};
getTypeName() => "ContractScheduledReturnInfo";
TypeContext? context = _ctx;
}
// @DataContract
class ContractScheduledReturnsResponse extends BaseResponse implements IConvertible
{
// @DataMember
List<ContractScheduledReturnInfo>? Contracts;
ContractScheduledReturnsResponse({this.Contracts});
ContractScheduledReturnsResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
super.fromMap(json);
Contracts = JsonConverters.fromJson(json['Contracts'],'List<ContractScheduledReturnInfo>',context!);
return this;
}
Map<String, dynamic> toJson() => super.toJson()..addAll({
'Contracts': JsonConverters.toJson(Contracts,'List<ContractScheduledReturnInfo>',context!)
});
getTypeName() => "ContractScheduledReturnsResponse";
TypeContext? context = _ctx;
}
/**
* ContractScheduledReturnsRequires active-e Contracts Service.
*/
// @DataContract
class ContractScheduledReturnsRequest extends BaseSecureRequest implements IConvertible
{
// @DataMember
DateTime? DateFrom;
// @DataMember
DateTime? DateTo;
// @DataMember
int? DistrictId;
// @DataMember
int? SchoolId;
// @DataMember
int? LocationId;
// @DataMember
int? StatusId;
// @DataMember
int? OptionId;
// @DataMember
bool? IncludeReturned;
// @DataMember
String? LanId;
ContractScheduledReturnsRequest({this.DateFrom,this.DateTo,this.DistrictId,this.SchoolId,this.LocationId,this.StatusId,this.OptionId,this.IncludeReturned,this.LanId});
ContractScheduledReturnsRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
super.fromMap(json);
DateFrom = JsonConverters.fromJson(json['DateFrom'],'DateTime',context!);
DateTo = JsonConverters.fromJson(json['DateTo'],'DateTime',context!);
DistrictId = json['DistrictId'];
SchoolId = json['SchoolId'];
LocationId = json['LocationId'];
StatusId = json['StatusId'];
OptionId = json['OptionId'];
IncludeReturned = json['IncludeReturned'];
LanId = json['LanId'];
return this;
}
Map<String, dynamic> toJson() => super.toJson()..addAll({
'DateFrom': JsonConverters.toJson(DateFrom,'DateTime',context!),
'DateTo': JsonConverters.toJson(DateTo,'DateTime',context!),
'DistrictId': DistrictId,
'SchoolId': SchoolId,
'LocationId': LocationId,
'StatusId': StatusId,
'OptionId': OptionId,
'IncludeReturned': IncludeReturned,
'LanId': LanId
});
getTypeName() => "ContractScheduledReturnsRequest";
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()),
'ContractScheduledReturnInfo': TypeInfo(TypeOf.Class, create:() => ContractScheduledReturnInfo()),
'ContractScheduledReturnsResponse': TypeInfo(TypeOf.Class, create:() => ContractScheduledReturnsResponse()),
'List<ContractScheduledReturnInfo>': TypeInfo(TypeOf.Class, create:() => <ContractScheduledReturnInfo>[]),
'ContractScheduledReturnsRequest': TypeInfo(TypeOf.Class, create:() => ContractScheduledReturnsRequest()),
});
Dart ContractScheduledReturnsRequest 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/ContractScheduledReturns HTTP/1.1 Host: active-ewebservice.biz Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"Contracts":[{"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","AutoPayHoldDate":"0001-01-01T00:00:00.0000000","MobileReturnedStatus":false}],"Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}