AIM Web Services

<back to all web services

ShortTermRentalInventoryRequest

ShortTermRentalInventory
Requires active-e Short Term Rental Service

The following routes are available for this service:
GET/api/ShortTermRentalInventory
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 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

        <DataContract>
        Public Partial Class ShortTermRentalInventoryObj
            Public Sub New()
                Rates = New List(Of ShortTermRentalInventoryRate)
                AvailableSerialPks = New List(Of Long)
            End Sub

            <DataMember>
            Public Overridable Property Rates As List(Of ShortTermRentalInventoryRate)

            <DataMember>
            Public Overridable Property AvailableSerialPks As List(Of Long)

            <DataMember>
            Public Overridable Property SaqPk As Nullable(Of Long)

            <DataMember>
            Public Overridable Property SkuPk As Nullable(Of Long)

            <DataMember>
            Public Overridable Property PkhPk As Nullable(Of Long)

            <DataMember>
            Public Overridable Property Sku As String

            <DataMember>
            Public Overridable Property Package As String

            <DataMember>
            Public Overridable Property InvType As String

            <DataMember>
            Public Overridable Property AvailableQty As Decimal
        End Class

        <DataContract>
        Public Partial Class ShortTermRentalInventoryRate
            <DataMember>
            Public Overridable Property HeaderDesc As String

            <DataMember>
            Public Overridable Property HeaderNotes As String

            <DataMember>
            Public Overridable Property Desc As String

            <DataMember>
            Public Overridable Property IntervalType As String

            <DataMember>
            Public Overridable Property Group As String

            <DataMember>
            Public Overridable Property Notes As String

            <DataMember>
            Public Overridable Property Amt As Decimal

            <DataMember>
            Public Overridable Property TimeInterval As Integer
        End Class

        '''<Summary>
        '''ShortTermRentalInventoryRequires active-e Short Term Rental Service
        '''</Summary>
        <DataContract>
        Public Partial Class ShortTermRentalInventoryRequest
            Inherits BaseSecureRequest
            '''<Summary>
            '''Item to lookup. Pass in either this *OR* ItemPk + PkType *OR* Category + SubCategory
            '''</Summary>
            <DataMember>
            <ApiMember(Description:="Item to lookup. Pass in either this *OR* ItemPk + PkType *OR* Category + SubCategory", Name:="Item", ParameterType:="query")>
            Public Overridable Property Item As String

            <DataMember>
            Public Overridable Property LocationCode As String

            '''<Summary>
            '''Key of the item to lookup. Pass in either this plus PkType *OR* Item *OR* Category + SubCategory
            '''</Summary>
            <DataMember>
            <ApiMember(Description:="Key of the item to lookup. Pass in either this plus PkType *OR* Item *OR* Category + SubCategory", Name:="ItemPk", ParameterType:="query")>
            Public Overridable Property ItemPk As Nullable(Of Long)

            '''<Summary>
            '''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
            '''</Summary>
            <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")>
            Public Overridable Property PkType As String

            '''<Summary>
            '''Pass in either SubCategory + this *OR* Item *OR* ItemPk + PkType
            '''</Summary>
            <DataMember>
            <ApiMember(Description:="Pass in either SubCategory + this *OR* Item *OR* ItemPk + PkType", Name:="Category", ParameterType:="query")>
            Public Overridable Property Category As Nullable(Of Integer)

            '''<Summary>
            '''Pass in either Category + this *OR* Item *OR* ItemPk + PkType
            '''</Summary>
            <DataMember>
            <ApiMember(Description:="Pass in either Category + this *OR* Item *OR* ItemPk + PkType", Name:="SubCategory", ParameterType:="query")>
            Public Overridable Property SubCategory As Nullable(Of Integer)
        End Class

        <DataContract>
        Public Partial Class ShortTermRentalInventoryResponse
            Inherits BaseResponse
            Public Sub New()
                Results = New List(Of ShortTermRentalInventoryObj)
            End Sub

            <DataMember>
            Public Overridable Property Results As List(Of ShortTermRentalInventoryObj)
        End Class
    End Namespace
End Namespace

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

HTTP + JSON

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"}}