| POST | /api/ShortTermRentalReservation |
|---|
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 ShortTermRentalReservationResponse extends BaseResponse implements IConvertible
{
// @DataMember
String? RefNumber;
ShortTermRentalReservationResponse({this.RefNumber});
ShortTermRentalReservationResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
super.fromMap(json);
RefNumber = json['RefNumber'];
return this;
}
Map<String, dynamic> toJson() => super.toJson()..addAll({
'RefNumber': RefNumber
});
getTypeName() => "ShortTermRentalReservationResponse";
TypeContext? context = _ctx;
}
// @DataContract
class PackageVariantItem implements IConvertible
{
// @DataMember
String? Model;
// @DataMember
String? Sku;
PackageVariantItem({this.Model,this.Sku});
PackageVariantItem.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
Model = json['Model'];
Sku = json['Sku'];
return this;
}
Map<String, dynamic> toJson() => {
'Model': Model,
'Sku': Sku
};
getTypeName() => "PackageVariantItem";
TypeContext? context = _ctx;
}
// @DataContract
class ShortTermRentalItem implements IConvertible
{
/**
* SasPk, SaqPk, or PkhPk
*/
// @DataMember
// @ApiMember(Description="SasPk, SaqPk, or PkhPk", IsRequired=true, Name="Pk", ParameterType="query")
int? Pk;
/**
* S for SerialNumber, P for Package deal. Empty for normal inventory.
*/
// @DataMember
// @ApiMember(Description="S for SerialNumber, P for Package deal. Empty for normal inventory.", Name="ItemType", ParameterType="query")
String? ItemType;
/**
* Quantity of item required. Does not apply to serial#s.
*/
// @DataMember
// @ApiMember(Description="Quantity of item required. Does not apply to serial#s.", Name="ItemQuantity", ParameterType="query")
double? ItemQuantity;
/**
* Item rate. This is per item, so the total is this multiplied by ItemQuantity.
*/
// @DataMember
// @ApiMember(Description="Item rate. This is per item, so the total is this multiplied by ItemQuantity.", IsRequired=true, Name="ItemRate", ParameterType="query")
double? ItemRate;
// @DataMember
String? Notes;
// @DataMember
List<PackageVariantItem>? PackageVariantItems;
ShortTermRentalItem({this.Pk,this.ItemType,this.ItemQuantity,this.ItemRate,this.Notes,this.PackageVariantItems});
ShortTermRentalItem.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
Pk = json['Pk'];
ItemType = json['ItemType'];
ItemQuantity = JsonConverters.toDouble(json['ItemQuantity']);
ItemRate = JsonConverters.toDouble(json['ItemRate']);
Notes = json['Notes'];
PackageVariantItems = JsonConverters.fromJson(json['PackageVariantItems'],'List<PackageVariantItem>',context!);
return this;
}
Map<String, dynamic> toJson() => {
'Pk': Pk,
'ItemType': ItemType,
'ItemQuantity': ItemQuantity,
'ItemRate': ItemRate,
'Notes': Notes,
'PackageVariantItems': JsonConverters.toJson(PackageVariantItems,'List<PackageVariantItem>',context!)
};
getTypeName() => "ShortTermRentalItem";
TypeContext? context = _ctx;
}
/**
* ShortTermRentalReservationRequires active-e Short Term Rental Service
*/
// @DataContract
class ShortTermRentalReservationRequest extends BaseSecureRequest implements IConvertible
{
/**
* Date/Time the item is to be picked up.
*/
// @DataMember
// @ApiMember(Description="Date/Time the item is to be picked up.", IsRequired=true, Name="PickupDate", ParameterType="query")
DateTime? PickupDate;
/**
* Date/Time the item is to be returned.
*/
// @DataMember
// @ApiMember(Description="Date/Time the item is to be returned.", IsRequired=true, Name="ReturnDate", ParameterType="query")
DateTime? ReturnDate;
/**
* Account of the customer making the reservation
*/
// @DataMember
// @ApiMember(Description="Account of the customer making the reservation", IsRequired=true, Name="CustomerAcct", ParameterType="query")
int? CustomerAcct;
// @DataMember
List<ShortTermRentalItem>? Items;
// @DataMember
String? Notes;
ShortTermRentalReservationRequest({this.PickupDate,this.ReturnDate,this.CustomerAcct,this.Items,this.Notes});
ShortTermRentalReservationRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
super.fromMap(json);
PickupDate = JsonConverters.fromJson(json['PickupDate'],'DateTime',context!);
ReturnDate = JsonConverters.fromJson(json['ReturnDate'],'DateTime',context!);
CustomerAcct = json['CustomerAcct'];
Items = JsonConverters.fromJson(json['Items'],'List<ShortTermRentalItem>',context!);
Notes = json['Notes'];
return this;
}
Map<String, dynamic> toJson() => super.toJson()..addAll({
'PickupDate': JsonConverters.toJson(PickupDate,'DateTime',context!),
'ReturnDate': JsonConverters.toJson(ReturnDate,'DateTime',context!),
'CustomerAcct': CustomerAcct,
'Items': JsonConverters.toJson(Items,'List<ShortTermRentalItem>',context!),
'Notes': Notes
});
getTypeName() => "ShortTermRentalReservationRequest";
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()),
'ShortTermRentalReservationResponse': TypeInfo(TypeOf.Class, create:() => ShortTermRentalReservationResponse()),
'PackageVariantItem': TypeInfo(TypeOf.Class, create:() => PackageVariantItem()),
'ShortTermRentalItem': TypeInfo(TypeOf.Class, create:() => ShortTermRentalItem()),
'List<PackageVariantItem>': TypeInfo(TypeOf.Class, create:() => <PackageVariantItem>[]),
'ShortTermRentalReservationRequest': TypeInfo(TypeOf.Class, create:() => ShortTermRentalReservationRequest()),
'List<ShortTermRentalItem>': TypeInfo(TypeOf.Class, create:() => <ShortTermRentalItem>[]),
});
Dart ShortTermRentalReservationRequest 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.
POST /api/ShortTermRentalReservation HTTP/1.1
Host: active-ewebservice.biz
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length
{"CustomerAcct":0,"Items":[{"Pk":0,"ItemType":"String","ItemQuantity":0,"ItemRate":0,"Notes":"String","PackageVariantItems":[{"Model":"String","Sku":"String"}]}],"Notes":"String","Token":"String","DeviceId":"String","AppId":"String","ApiKey":"String","OAuthToken":"String"}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length
{"RefNumber":"String","Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}