AIM Web Services

<back to all web services

ShortTermRentalReservationRequest

ShortTermRentalReservation
Requires active-e Short Term Rental Service

The following routes are available for this service:
POST/api/ShortTermRentalReservation
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 PackageVariantItem
            <DataMember>
            Public Overridable Property Model As String

            <DataMember>
            Public Overridable Property Sku As String
        End Class

        <DataContract>
        Public Partial Class ShortTermRentalItem
            Public Sub New()
                PackageVariantItems = New List(Of PackageVariantItem)
            End Sub

            '''<Summary>
            '''SasPk, SaqPk, or PkhPk
            '''</Summary>
            <DataMember>
            <ApiMember(Description:="SasPk, SaqPk, or PkhPk", IsRequired:=true, Name:="Pk", ParameterType:="query")>
            Public Overridable Property Pk As Long

            '''<Summary>
            '''S for SerialNumber, P for Package deal. Empty for normal inventory.
            '''</Summary>
            <DataMember>
            <ApiMember(Description:="S for SerialNumber, P for Package deal. Empty for normal inventory.", Name:="ItemType", ParameterType:="query")>
            Public Overridable Property ItemType As String

            '''<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.", Name:="ItemQuantity", ParameterType:="query")>
            Public Overridable Property ItemQuantity As Nullable(Of Decimal)

            '''<Summary>
            '''Item rate. This is per item, so the total is this multiplied by ItemQuantity.
            '''</Summary>
            <DataMember>
            <ApiMember(Description:="Item rate. This is per item, so the total is this multiplied by ItemQuantity.", IsRequired:=true, Name:="ItemRate", ParameterType:="query")>
            Public Overridable Property ItemRate As Nullable(Of Decimal)

            <DataMember>
            Public Overridable Property Notes As String

            <DataMember>
            Public Overridable Property PackageVariantItems As List(Of PackageVariantItem)
        End Class

        '''<Summary>
        '''ShortTermRentalReservationRequires active-e Short Term Rental Service
        '''</Summary>
        <DataContract>
        Public Partial Class ShortTermRentalReservationRequest
            Inherits BaseSecureRequest
            Public Sub New()
                Items = New List(Of ShortTermRentalItem)
            End Sub

            '''<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>
            '''Account of the customer making the reservation
            '''</Summary>
            <DataMember>
            <ApiMember(Description:="Account of the customer making the reservation", IsRequired:=true, Name:="CustomerAcct", ParameterType:="query")>
            Public Overridable Property CustomerAcct As Integer

            <DataMember>
            Public Overridable Property Items As List(Of ShortTermRentalItem)

            <DataMember>
            Public Overridable Property Notes As String
        End Class

        <DataContract>
        Public Partial Class ShortTermRentalReservationResponse
            Inherits BaseResponse
            <DataMember>
            Public Overridable Property RefNumber As String
        End Class
    End Namespace
End Namespace

VB.NET ShortTermRentalReservationRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

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: application/xml
Content-Type: application/xml
Content-Length: length

<ShortTermRentalReservationRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AIM.WebService">
  <ApiKey>String</ApiKey>
  <OAuthToken>String</OAuthToken>
  <AppId>String</AppId>
  <DeviceId>String</DeviceId>
  <Token>String</Token>
  <CustomerAcct>0</CustomerAcct>
  <Items>
    <ShortTermRentalItem>
      <ItemQuantity>0</ItemQuantity>
      <ItemRate>0</ItemRate>
      <ItemType>String</ItemType>
      <Notes>String</Notes>
      <PackageVariantItems>
        <PackageVariantItem>
          <Model>String</Model>
          <Sku>String</Sku>
        </PackageVariantItem>
      </PackageVariantItems>
      <Pk>0</Pk>
    </ShortTermRentalItem>
  </Items>
  <Notes>String</Notes>
  <PickupDate>0001-01-01T00:00:00</PickupDate>
  <ReturnDate>0001-01-01T00:00:00</ReturnDate>
</ShortTermRentalReservationRequest>

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

<ShortTermRentalReservationResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AIM.WebService">
  <Status>
    <DomainName>String</DomainName>
    <ErrorCode>String</ErrorCode>
    <ErrorDisplayText>String</ErrorDisplayText>
    <ErrorMessage>String</ErrorMessage>
    <IpAddress>String</IpAddress>
    <Login>String</Login>
    <StatusCode>String</StatusCode>
  </Status>
  <RefNumber>String</RefNumber>
</ShortTermRentalReservationResponse>