| GET | /api/ShortTermRentalInventory |
|---|
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 ShortTermRentalInventoryRate implements IConvertible
{
// @DataMember
String? HeaderDesc;
// @DataMember
String? HeaderNotes;
// @DataMember
String? Desc;
// @DataMember
String? IntervalType;
// @DataMember
String? Group;
// @DataMember
String? Notes;
// @DataMember
double? Amt;
// @DataMember
int? TimeInterval;
ShortTermRentalInventoryRate({this.HeaderDesc,this.HeaderNotes,this.Desc,this.IntervalType,this.Group,this.Notes,this.Amt,this.TimeInterval});
ShortTermRentalInventoryRate.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
HeaderDesc = json['HeaderDesc'];
HeaderNotes = json['HeaderNotes'];
Desc = json['Desc'];
IntervalType = json['IntervalType'];
Group = json['Group'];
Notes = json['Notes'];
Amt = JsonConverters.toDouble(json['Amt']);
TimeInterval = json['TimeInterval'];
return this;
}
Map<String, dynamic> toJson() => {
'HeaderDesc': HeaderDesc,
'HeaderNotes': HeaderNotes,
'Desc': Desc,
'IntervalType': IntervalType,
'Group': Group,
'Notes': Notes,
'Amt': Amt,
'TimeInterval': TimeInterval
};
getTypeName() => "ShortTermRentalInventoryRate";
TypeContext? context = _ctx;
}
// @DataContract
class ShortTermRentalInventoryObj implements IConvertible
{
// @DataMember
List<ShortTermRentalInventoryRate>? Rates;
// @DataMember
List<int>? AvailableSerialPks;
// @DataMember
int? SaqPk;
// @DataMember
int? SkuPk;
// @DataMember
int? PkhPk;
// @DataMember
String? Sku;
// @DataMember
String? Package;
// @DataMember
String? InvType;
// @DataMember
double? AvailableQty;
ShortTermRentalInventoryObj({this.Rates,this.AvailableSerialPks,this.SaqPk,this.SkuPk,this.PkhPk,this.Sku,this.Package,this.InvType,this.AvailableQty});
ShortTermRentalInventoryObj.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
Rates = JsonConverters.fromJson(json['Rates'],'List<ShortTermRentalInventoryRate>',context!);
AvailableSerialPks = JsonConverters.fromJson(json['AvailableSerialPks'],'List<int>',context!);
SaqPk = json['SaqPk'];
SkuPk = json['SkuPk'];
PkhPk = json['PkhPk'];
Sku = json['Sku'];
Package = json['Package'];
InvType = json['InvType'];
AvailableQty = JsonConverters.toDouble(json['AvailableQty']);
return this;
}
Map<String, dynamic> toJson() => {
'Rates': JsonConverters.toJson(Rates,'List<ShortTermRentalInventoryRate>',context!),
'AvailableSerialPks': JsonConverters.toJson(AvailableSerialPks,'List<int>',context!),
'SaqPk': SaqPk,
'SkuPk': SkuPk,
'PkhPk': PkhPk,
'Sku': Sku,
'Package': Package,
'InvType': InvType,
'AvailableQty': AvailableQty
};
getTypeName() => "ShortTermRentalInventoryObj";
TypeContext? context = _ctx;
}
// @DataContract
class ShortTermRentalInventoryResponse extends BaseResponse implements IConvertible
{
// @DataMember
List<ShortTermRentalInventoryObj>? Results;
ShortTermRentalInventoryResponse({this.Results});
ShortTermRentalInventoryResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
super.fromMap(json);
Results = JsonConverters.fromJson(json['Results'],'List<ShortTermRentalInventoryObj>',context!);
return this;
}
Map<String, dynamic> toJson() => super.toJson()..addAll({
'Results': JsonConverters.toJson(Results,'List<ShortTermRentalInventoryObj>',context!)
});
getTypeName() => "ShortTermRentalInventoryResponse";
TypeContext? context = _ctx;
}
/**
* ShortTermRentalInventoryRequires active-e Short Term Rental Service
*/
// @DataContract
class ShortTermRentalInventoryRequest extends BaseSecureRequest implements IConvertible
{
/**
* Item to lookup. Pass in either this *OR* ItemPk + PkType *OR* Category + SubCategory
*/
// @DataMember
// @ApiMember(Description="Item to lookup. Pass in either this *OR* ItemPk + PkType *OR* Category + SubCategory", Name="Item", ParameterType="query")
String? Item;
// @DataMember
String? LocationCode;
/**
* Key of the item to lookup. Pass in either this plus PkType *OR* Item *OR* Category + SubCategory
*/
// @DataMember
// @ApiMember(Description="Key of the item to lookup. Pass in either this plus PkType *OR* Item *OR* Category + SubCategory", Name="ItemPk", ParameterType="query")
int? ItemPk;
/**
* Type of the key passed in. S for SasPk, Q for SaqPk, P for PkhPk. Pass in either this plus ItemPk *OR* Item *OR* Category + SubCategory
*/
// @DataMember
// @ApiMember(Description="Type of the key passed in. S for SasPk, Q for SaqPk, P for PkhPk. Pass in either this plus ItemPk *OR* Item *OR* Category + SubCategory", Name="PkType", ParameterType="query")
String? PkType;
/**
* Pass in either SubCategory + this *OR* Item *OR* ItemPk + PkType
*/
// @DataMember
// @ApiMember(Description="Pass in either SubCategory + this *OR* Item *OR* ItemPk + PkType", Name="Category", ParameterType="query")
int? Category;
/**
* Pass in either Category + this *OR* Item *OR* ItemPk + PkType
*/
// @DataMember
// @ApiMember(Description="Pass in either Category + this *OR* Item *OR* ItemPk + PkType", Name="SubCategory", ParameterType="query")
int? SubCategory;
ShortTermRentalInventoryRequest({this.Item,this.LocationCode,this.ItemPk,this.PkType,this.Category,this.SubCategory});
ShortTermRentalInventoryRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
super.fromMap(json);
Item = json['Item'];
LocationCode = json['LocationCode'];
ItemPk = json['ItemPk'];
PkType = json['PkType'];
Category = json['Category'];
SubCategory = json['SubCategory'];
return this;
}
Map<String, dynamic> toJson() => super.toJson()..addAll({
'Item': Item,
'LocationCode': LocationCode,
'ItemPk': ItemPk,
'PkType': PkType,
'Category': Category,
'SubCategory': SubCategory
});
getTypeName() => "ShortTermRentalInventoryRequest";
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()),
'ShortTermRentalInventoryRate': TypeInfo(TypeOf.Class, create:() => ShortTermRentalInventoryRate()),
'ShortTermRentalInventoryObj': TypeInfo(TypeOf.Class, create:() => ShortTermRentalInventoryObj()),
'List<ShortTermRentalInventoryRate>': TypeInfo(TypeOf.Class, create:() => <ShortTermRentalInventoryRate>[]),
'ShortTermRentalInventoryResponse': TypeInfo(TypeOf.Class, create:() => ShortTermRentalInventoryResponse()),
'List<ShortTermRentalInventoryObj>': TypeInfo(TypeOf.Class, create:() => <ShortTermRentalInventoryObj>[]),
'ShortTermRentalInventoryRequest': TypeInfo(TypeOf.Class, create:() => ShortTermRentalInventoryRequest()),
});
Dart ShortTermRentalInventoryRequest 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/ShortTermRentalInventory HTTP/1.1 Host: active-ewebservice.biz Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"Results":[{"Rates":[{"HeaderDesc":"String","HeaderNotes":"String","Desc":"String","IntervalType":"String","Group":"String","Notes":"String","Amt":0,"TimeInterval":0}],"AvailableSerialPks":[0],"SaqPk":0,"SkuPk":0,"PkhPk":0,"Sku":"String","Package":"String","InvType":"String","AvailableQty":0}],"Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}