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


/**
* ShortTermRentalInventoryRequires active-e Short Term Rental Service
*/
@DataContract
open class ShortTermRentalInventoryRequest : BaseSecureRequest()
{
    /**
    * Item to lookup. Pass in either this *OR* ItemPk + PkType *OR* Category + SubCategory
    */
    @DataMember
    @ApiMember(Description="Item to lookup. Pass in either this *OR* ItemPk + PkType *OR* Category + SubCategory", Name="Item", ParameterType="query")
    var Item:String? = null

    @DataMember
    var LocationCode:String? = null

    /**
    * Key of the item to lookup. Pass in either this plus PkType *OR* Item *OR* Category + SubCategory
    */
    @DataMember
    @ApiMember(Description="Key of the item to lookup. Pass in either this plus PkType *OR* Item *OR* Category + SubCategory", Name="ItemPk", ParameterType="query")
    var ItemPk:Long? = null

    /**
    * 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
    */
    @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")
    var PkType:String? = null

    /**
    * Pass in either SubCategory + this *OR* Item *OR* ItemPk + PkType
    */
    @DataMember
    @ApiMember(Description="Pass in either SubCategory + this *OR* Item *OR* ItemPk + PkType", Name="Category", ParameterType="query")
    var Category:Int? = null

    /**
    * Pass in either Category + this *OR* Item *OR* ItemPk + PkType
    */
    @DataMember
    @ApiMember(Description="Pass in either Category + this *OR* Item *OR* ItemPk + PkType", Name="SubCategory", ParameterType="query")
    var SubCategory:Int? = 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 ShortTermRentalInventoryResponse : BaseResponse()
{
    @DataMember
    var Results:ArrayList<ShortTermRentalInventoryObj> = ArrayList<ShortTermRentalInventoryObj>()
}

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

@DataContract
open class ShortTermRentalInventoryObj
{
    @DataMember
    var Rates:ArrayList<ShortTermRentalInventoryRate> = ArrayList<ShortTermRentalInventoryRate>()

    @DataMember
    var AvailableSerialPks:ArrayList<Long> = ArrayList<Long>()

    @DataMember
    var SaqPk:Long? = null

    @DataMember
    var SkuPk:Long? = null

    @DataMember
    var PkhPk:Long? = null

    @DataMember
    var Sku:String? = null

    @DataMember
    var Package:String? = null

    @DataMember
    var InvType:String? = null

    @DataMember
    var AvailableQty:BigDecimal? = null
}

@DataContract
open class ShortTermRentalInventoryRate
{
    @DataMember
    var HeaderDesc:String? = null

    @DataMember
    var HeaderNotes:String? = null

    @DataMember
    var Desc:String? = null

    @DataMember
    var IntervalType:String? = null

    @DataMember
    var Group:String? = null

    @DataMember
    var Notes:String? = null

    @DataMember
    var Amt:BigDecimal? = null

    @DataMember
    var TimeInterval:Int? = null
}

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

GET /api/ShortTermRentalInventory HTTP/1.1 
Host: active-ewebservice.biz 
Accept: application/xml

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

<ShortTermRentalInventoryResponse 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>
  <Results>
    <ShortTermRentalInventoryObj>
      <AvailableQty>0</AvailableQty>
      <AvailableSerialPks xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:long>0</d4p1:long>
      </AvailableSerialPks>
      <InvType>String</InvType>
      <Package>String</Package>
      <PkhPk>0</PkhPk>
      <Rates>
        <ShortTermRentalInventoryRate>
          <Amt>0</Amt>
          <Desc>String</Desc>
          <Group>String</Group>
          <HeaderDesc>String</HeaderDesc>
          <HeaderNotes>String</HeaderNotes>
          <IntervalType>String</IntervalType>
          <Notes>String</Notes>
          <TimeInterval>0</TimeInterval>
        </ShortTermRentalInventoryRate>
      </Rates>
      <SaqPk>0</SaqPk>
      <Sku>String</Sku>
      <SkuPk>0</SkuPk>
    </ShortTermRentalInventoryObj>
  </Results>
</ShortTermRentalInventoryResponse>