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
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports AIM.WebService

Namespace Global

    Namespace AIM.WebService

        <DataContract>
        Public Partial Class AvailableSku
            <DataMember>
            Public Overridable Property SaqPk As Long

            <DataMember>
            Public Overridable Property Sku As String

            <DataMember>
            Public Overridable Property Description As String
        End Class

        <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 Overridable Property ApiKey As String

            <DataMember>
            <ApiMember(DataType:="string", Name:="OAuthToken", ParameterType:="header")>
            Public Overridable Property OAuthToken As String
        End Class

        <DataContract>
        Public Partial Class BaseResponse
            '''<Summary>
            '''
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="BaseResponseResult", Description:="", Name:="Status", ParameterType:="body")>
            Public Overridable Property Status As BaseResponseResult

            <DataContract>
            Public Partial Class BaseResponseResult
                '''<Summary>
                '''
                '''</Summary>
                <DataMember>
                <ApiMember(DataType:="string", Description:="", Name:="StatusCode", ParameterType:="body")>
                Public Overridable Property StatusCode As String

                '''<Summary>
                '''
                '''</Summary>
                <DataMember>
                <ApiMember(DataType:="string", Description:="", Name:="Login", ParameterType:="body")>
                Public Overridable Property Login As String

                '''<Summary>
                '''
                '''</Summary>
                <DataMember>
                <ApiMember(DataType:="string", Description:="", Name:="ErrorCode", ParameterType:="body")>
                Public Overridable Property ErrorCode As String

                '''<Summary>
                '''
                '''</Summary>
                <DataMember>
                <ApiMember(DataType:="string", Description:="", Name:="ErrorDisplayText", ParameterType:="body")>
                Public Overridable Property ErrorDisplayText As String

                '''<Summary>
                '''
                '''</Summary>
                <DataMember>
                <ApiMember(DataType:="string", Description:="", Name:="ErrorMessage", ParameterType:="body")>
                Public Overridable Property ErrorMessage As String

                '''<Summary>
                '''
                '''</Summary>
                <DataMember>
                <ApiMember(DataType:="string", Description:="", ExcludeInSchema:=true, Name:="DomainName", ParameterType:="body")>
                Public Overridable Property DomainName As String

                '''<Summary>
                '''
                '''</Summary>
                <DataMember>
                <ApiMember(DataType:="string", Description:="", ExcludeInSchema:=true, Name:="IPAddress", ParameterType:="body")>
                Public Overridable Property IpAddress As String
            End Class
        End Class

        <DataContract>
        Public Partial Class BaseSecureRequest
            Inherits BaseRequest
            '''<Summary>
            '''
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="string", Description:="", Name:="Token", ParameterType:="Header")>
            Public Overridable Property Token As String

            '''<Summary>
            '''
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="string", Description:="", Name:="DeviceId", ParameterType:="Header")>
            Public Overridable Property DeviceId As String

            '''<Summary>
            '''
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="string", Description:="", IsRequired:=true, Name:="AppId", ParameterType:="Header")>
            Public Overridable Property AppId As String
        End Class

        '''<Summary>
        '''ShortTermRentalAvailabilityRequires active-e Short Term Rental Service
        '''</Summary>
        <DataContract>
        Public Partial Class ShortTermRentalAvailabilityRequest
            Inherits 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 Overridable Property PickupDate As Date

            '''<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 Overridable Property ReturnDate As Date

            '''<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 Overridable Property SaqPk As Nullable(Of Long)

            '''<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 Overridable Property SasPk As Nullable(Of Long)

            '''<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 Overridable Property PkhPk As Nullable(Of Long)

            '''<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 Overridable Property Category As Nullable(Of Integer)

            '''<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 Overridable Property SubCategory As Nullable(Of Integer)

            '''<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 Overridable Property ItemQuantity As Nullable(Of Decimal)
        End Class

        <DataContract>
        Public Partial Class ShortTermRentalAvailabilityResponse
            Inherits BaseResponse
            Public Sub New()
                AvailableSkus = New List(Of AvailableSku)
            End Sub

            <DataMember>
            Public Overridable Property IsAvailable As Boolean

            <DataMember>
            Public Overridable Property AvailableSkus As List(Of AvailableSku)
        End Class
    End Namespace
End Namespace

VB.NET 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"}}