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
import java.math.*
import java.util.*
import net.servicestack.client.*


/**
* ShortTermRentalReservationRequires active-e Short Term Rental Service
*/
@DataContract
open class ShortTermRentalReservationRequest : BaseSecureRequest()
{
    /**
    * 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")
    var PickupDate:Date? = null

    /**
    * 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")
    var ReturnDate:Date? = null

    /**
    * Account of the customer making the reservation
    */
    @DataMember
    @ApiMember(Description="Account of the customer making the reservation", IsRequired=true, Name="CustomerAcct", ParameterType="query")
    var CustomerAcct:Int? = null

    @DataMember
    var Items:ArrayList<ShortTermRentalItem> = ArrayList<ShortTermRentalItem>()

    @DataMember
    var Notes:String? = null
}

@DataContract
open class BaseSecureRequest : BaseRequest()
{
    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", Name="Token", ParameterType="Header")
    var Token:String? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", Name="DeviceId", ParameterType="Header")
    var DeviceId:String? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", IsRequired=true, Name="AppId", ParameterType="Header")
    var AppId:String? = null
}

@DataContract
open class BaseRequest
{
    /**
    * 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")
    var ApiKey:String? = null

    @DataMember
    @ApiMember(DataType="string", Name="OAuthToken", ParameterType="header")
    var OAuthToken:String? = null
}

@DataContract
open class ShortTermRentalItem
{
    /**
    * SasPk, SaqPk, or PkhPk
    */
    @DataMember
    @ApiMember(Description="SasPk, SaqPk, or PkhPk", IsRequired=true, Name="Pk", ParameterType="query")
    var Pk:Long? = null

    /**
    * S for SerialNumber, P for Package deal. Empty for normal inventory.
    */
    @DataMember
    @ApiMember(Description="S for SerialNumber, P for Package deal. Empty for normal inventory.", Name="ItemType", ParameterType="query")
    var ItemType:String? = null

    /**
    * Quantity of item required. Does not apply to serial#s.
    */
    @DataMember
    @ApiMember(Description="Quantity of item required. Does not apply to serial#s.", Name="ItemQuantity", ParameterType="query")
    var ItemQuantity:BigDecimal? = null

    /**
    * Item rate. This is per item, so the total is this multiplied by ItemQuantity.
    */
    @DataMember
    @ApiMember(Description="Item rate. This is per item, so the total is this multiplied by ItemQuantity.", IsRequired=true, Name="ItemRate", ParameterType="query")
    var ItemRate:BigDecimal? = null

    @DataMember
    var Notes:String? = null

    @DataMember
    var PackageVariantItems:ArrayList<PackageVariantItem> = ArrayList<PackageVariantItem>()
}

@DataContract
open class PackageVariantItem
{
    @DataMember
    var Model:String? = null

    @DataMember
    var Sku:String? = null
}

@DataContract
open class ShortTermRentalReservationResponse : BaseResponse()
{
    @DataMember
    var RefNumber:String? = null
}

@DataContract
open class BaseResponse
{
    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")
    var Status:BaseResponseResult? = null
}

@DataContract
open class BaseResponseResult
{
    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", Name="StatusCode", ParameterType="body")
    var StatusCode:String? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", Name="Login", ParameterType="body")
    var Login:String? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", Name="ErrorCode", ParameterType="body")
    var ErrorCode:String? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", Name="ErrorDisplayText", ParameterType="body")
    var ErrorDisplayText:String? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", Name="ErrorMessage", ParameterType="body")
    var ErrorMessage:String? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="DomainName", ParameterType="body")
    var DomainName:String? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")
    var IpAddress:String? = null
}

Kotlin 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>