AIM Web Services

<back to all web services

ShortTermRentalAvailabilityRequest

ShortTermRentalAvailability
Requires active-e Short Term Rental Service

using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using AIM.WebService;

namespace AIM.WebService
{
    [DataContract]
    public partial class AvailableSku
    {
        [DataMember]
        public virtual long SaqPk { get; set; }

        [DataMember]
        public virtual string Sku { get; set; }

        [DataMember]
        public virtual string Description { get; set; }
    }

    [DataContract]
    public partial class BaseRequest
    {
        ///<summary>
        ///This is your AIM API Key provided by Tri-Tech
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="This is your AIM API Key provided by Tri-Tech", IsRequired=true, Name="ApiKey", ParameterType="header")]
        public virtual string ApiKey { get; set; }

        [DataMember]
        [ApiMember(DataType="string", Name="OAuthToken", ParameterType="header")]
        public virtual string OAuthToken { get; set; }
    }

    [DataContract]
    public partial class BaseResponse
    {
        ///<summary>
        ///
        ///</summary>
        [DataMember]
        [ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")]
        public virtual BaseResponseResult Status { get; set; }
        [DataContract]
        public partial class BaseResponseResult
        {
            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", Name="StatusCode", ParameterType="body")]
            public virtual string StatusCode { get; set; }

            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", Name="Login", ParameterType="body")]
            public virtual string Login { get; set; }

            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", Name="ErrorCode", ParameterType="body")]
            public virtual string ErrorCode { get; set; }

            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", Name="ErrorDisplayText", ParameterType="body")]
            public virtual string ErrorDisplayText { get; set; }

            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", Name="ErrorMessage", ParameterType="body")]
            public virtual string ErrorMessage { get; set; }

            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="DomainName", ParameterType="body")]
            public virtual string DomainName { get; set; }

            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")]
            public virtual string IpAddress { get; set; }
        }

    }

    [DataContract]
    public partial class BaseSecureRequest
        : BaseRequest
    {
        ///<summary>
        ///
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="", Name="Token", ParameterType="Header")]
        public virtual string Token { get; set; }

        ///<summary>
        ///
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="", Name="DeviceId", ParameterType="Header")]
        public virtual string DeviceId { get; set; }

        ///<summary>
        ///
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="", IsRequired=true, Name="AppId", ParameterType="Header")]
        public virtual string AppId { get; set; }
    }

    ///<summary>
    ///ShortTermRentalAvailabilityRequires active-e Short Term Rental Service
    ///</summary>
    [DataContract]
    public partial class ShortTermRentalAvailabilityRequest
        : BaseSecureRequest
    {
        ///<summary>
        ///Date/Time the item is to be picked up.
        ///</summary>
        [DataMember]
        [ApiMember(Description="Date/Time the item is to be picked up.", IsRequired=true, Name="PickupDate", ParameterType="query")]
        public virtual DateTime PickupDate { get; set; }

        ///<summary>
        ///Date/Time the item is to be returned.
        ///</summary>
        [DataMember]
        [ApiMember(Description="Date/Time the item is to be returned.", IsRequired=true, Name="ReturnDate", ParameterType="query")]
        public virtual DateTime ReturnDate { get; set; }

        ///<summary>
        ///PK of the Scsaqty to lookup. Pass in SkuPk *OR* SasPK *OR* PkhPk *OR* Category and SubCategory
        ///</summary>
        [DataMember]
        [ApiMember(Description="PK of the Scsaqty to lookup. Pass in SkuPk *OR* SasPK *OR* PkhPk *OR* Category and SubCategory", Name="SaqPk", ParameterType="query")]
        public virtual long? SaqPk { get; set; }

        ///<summary>
        ///PK of the Serial# to lookup. Pass in SkuPk *OR* SasPK *OR* PkhPk *OR* Category and SubCategory
        ///</summary>
        [DataMember]
        [ApiMember(Description="PK of the Serial# to lookup. Pass in SkuPk *OR* SasPK *OR* PkhPk *OR* Category and SubCategory", Name="SasPk", ParameterType="query")]
        public virtual long? SasPk { get; set; }

        ///<summary>
        ///PK of the Package Deal to lookup. Pass in SkuPk *OR* SasPK *OR* PkhPk *OR* Category and SubCategory
        ///</summary>
        [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")]
        public virtual long? PkhPk { get; set; }

        ///<summary>
        ///Pass in SkuPk *OR* SasPK *OR* PkhPk *OR* Category and SubCategory
        ///</summary>
        [DataMember]
        [ApiMember(Description="Pass in SkuPk *OR* SasPK *OR* PkhPk *OR* Category and SubCategory", Name="Category", ParameterType="query")]
        public virtual int? Category { get; set; }

        ///<summary>
        ///Pass in SkuPk *OR* SasPK *OR* PkhPk *OR* Category and SubCategory
        ///</summary>
        [DataMember]
        [ApiMember(Description="Pass in SkuPk *OR* SasPK *OR* PkhPk *OR* Category and SubCategory", Name="SubCategory", ParameterType="query")]
        public virtual int? SubCategory { get; set; }

        ///<summary>
        ///Quantity of item required. Does not apply to serial#s.
        ///</summary>
        [DataMember]
        [ApiMember(Description="Quantity of item required. Does not apply to serial#s.", IsRequired=true, Name="ItemQuantity", ParameterType="query")]
        public virtual decimal? ItemQuantity { get; set; }
    }

    [DataContract]
    public partial class ShortTermRentalAvailabilityResponse
        : BaseResponse
    {
        public ShortTermRentalAvailabilityResponse()
        {
            AvailableSkus = new List<AvailableSku>{};
        }

        [DataMember]
        public virtual bool IsAvailable { get; set; }

        [DataMember]
        public virtual List<AvailableSku> AvailableSkus { get; set; }
    }

}

C# ShortTermRentalAvailabilityRequest DTOs

GET /api/ShortTermRentalAvailability HTTP/1.1 
Host: active-ewebservice.biz 
Accept: text/jsonl

HTTP/1.1 200 OK
Content-Type: text/jsonl
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"}}