AIM Web Services

<back to all web services

ShortTermRentalAvailabilityRequest

ShortTermRentalAvailability
Requires active-e Short Term Rental Service

The following routes are available for this service:
GET/api/ShortTermRentalAvailability
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 AvailableSku implements IConvertible
{
    // @DataMember
    int? SaqPk;

    // @DataMember
    String? Sku;

    // @DataMember
    String? Description;

    AvailableSku({this.SaqPk,this.Sku,this.Description});
    AvailableSku.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        SaqPk = json['SaqPk'];
        Sku = json['Sku'];
        Description = json['Description'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'SaqPk': SaqPk,
        'Sku': Sku,
        'Description': Description
    };

    getTypeName() => "AvailableSku";
    TypeContext? context = _ctx;
}

// @DataContract
class ShortTermRentalAvailabilityResponse extends BaseResponse implements IConvertible
{
    // @DataMember
    bool? IsAvailable;

    // @DataMember
    List<AvailableSku>? AvailableSkus;

    ShortTermRentalAvailabilityResponse({this.IsAvailable,this.AvailableSkus});
    ShortTermRentalAvailabilityResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        IsAvailable = json['IsAvailable'];
        AvailableSkus = JsonConverters.fromJson(json['AvailableSkus'],'List<AvailableSku>',context!);
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson()..addAll({
        'IsAvailable': IsAvailable,
        'AvailableSkus': JsonConverters.toJson(AvailableSkus,'List<AvailableSku>',context!)
    });

    getTypeName() => "ShortTermRentalAvailabilityResponse";
    TypeContext? context = _ctx;
}

/**
* ShortTermRentalAvailabilityRequires active-e Short Term Rental Service
*/
// @DataContract
class ShortTermRentalAvailabilityRequest 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;

    /**
    * PK of the Scsaqty to lookup. Pass in SkuPk *OR* SasPK *OR* PkhPk *OR* Category and SubCategory
    */
    // @DataMember
    // @ApiMember(Description="PK of the Scsaqty to lookup. Pass in SkuPk *OR* SasPK *OR* PkhPk *OR* Category and SubCategory", Name="SaqPk", ParameterType="query")
    int? SaqPk;

    /**
    * PK of the Serial# to lookup. Pass in SkuPk *OR* SasPK *OR* PkhPk *OR* Category and SubCategory
    */
    // @DataMember
    // @ApiMember(Description="PK of the Serial# to lookup. Pass in SkuPk *OR* SasPK *OR* PkhPk *OR* Category and SubCategory", Name="SasPk", ParameterType="query")
    int? SasPk;

    /**
    * PK of the Package Deal to lookup. Pass in SkuPk *OR* SasPK *OR* PkhPk *OR* Category and SubCategory
    */
    // @DataMember
    // @ApiMember(Description="PK of the Package Deal to lookup. Pass in SkuPk *OR* SasPK *OR* PkhPk *OR* Category and SubCategory", Name="PkhPk", ParameterType="query")
    int? PkhPk;

    /**
    * Pass in SkuPk *OR* SasPK *OR* PkhPk *OR* Category and SubCategory
    */
    // @DataMember
    // @ApiMember(Description="Pass in SkuPk *OR* SasPK *OR* PkhPk *OR* Category and SubCategory", Name="Category", ParameterType="query")
    int? Category;

    /**
    * Pass in SkuPk *OR* SasPK *OR* PkhPk *OR* Category and SubCategory
    */
    // @DataMember
    // @ApiMember(Description="Pass in SkuPk *OR* SasPK *OR* PkhPk *OR* Category and SubCategory", Name="SubCategory", ParameterType="query")
    int? SubCategory;

    /**
    * Quantity of item required. Does not apply to serial#s.
    */
    // @DataMember
    // @ApiMember(Description="Quantity of item required. Does not apply to serial#s.", IsRequired=true, Name="ItemQuantity", ParameterType="query")
    double? ItemQuantity;

    ShortTermRentalAvailabilityRequest({this.PickupDate,this.ReturnDate,this.SaqPk,this.SasPk,this.PkhPk,this.Category,this.SubCategory,this.ItemQuantity});
    ShortTermRentalAvailabilityRequest.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!);
        SaqPk = json['SaqPk'];
        SasPk = json['SasPk'];
        PkhPk = json['PkhPk'];
        Category = json['Category'];
        SubCategory = json['SubCategory'];
        ItemQuantity = JsonConverters.toDouble(json['ItemQuantity']);
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson()..addAll({
        'PickupDate': JsonConverters.toJson(PickupDate,'DateTime',context!),
        'ReturnDate': JsonConverters.toJson(ReturnDate,'DateTime',context!),
        'SaqPk': SaqPk,
        'SasPk': SasPk,
        'PkhPk': PkhPk,
        'Category': Category,
        'SubCategory': SubCategory,
        'ItemQuantity': ItemQuantity
    });

    getTypeName() => "ShortTermRentalAvailabilityRequest";
    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()),
    'AvailableSku': TypeInfo(TypeOf.Class, create:() => AvailableSku()),
    'ShortTermRentalAvailabilityResponse': TypeInfo(TypeOf.Class, create:() => ShortTermRentalAvailabilityResponse()),
    'List<AvailableSku>': TypeInfo(TypeOf.Class, create:() => <AvailableSku>[]),
    'ShortTermRentalAvailabilityRequest': TypeInfo(TypeOf.Class, create:() => ShortTermRentalAvailabilityRequest()),
});

Dart ShortTermRentalAvailabilityRequest 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

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /api/ShortTermRentalAvailability HTTP/1.1 
Host: active-ewebservice.biz 
Accept: application/json

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"IsAvailable":false,"AvailableSkus":[{"SaqPk":0,"Sku":"String","Description":"String"}],"Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}