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
namespace AIM.WebService

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<DataContract>]
    [<AllowNullLiteral>]
    type BaseResponseResult() = 
        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", Name="StatusCode", ParameterType="body")>]
        member val StatusCode:String = null with get,set

        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", Name="Login", ParameterType="body")>]
        member val Login:String = null with get,set

        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", Name="ErrorCode", ParameterType="body")>]
        member val ErrorCode:String = null with get,set

        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", Name="ErrorDisplayText", ParameterType="body")>]
        member val ErrorDisplayText:String = null with get,set

        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", Name="ErrorMessage", ParameterType="body")>]
        member val ErrorMessage:String = null with get,set

        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="DomainName", ParameterType="body")>]
        member val DomainName:String = null with get,set

        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")>]
        member val IpAddress:String = null with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type BaseResponse() = 
        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")>]
        member val Status:BaseResponseResult = null with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type ShortTermRentalInventoryRate() = 
        [<DataMember>]
        member val HeaderDesc:String = null with get,set

        [<DataMember>]
        member val HeaderNotes:String = null with get,set

        [<DataMember>]
        member val Desc:String = null with get,set

        [<DataMember>]
        member val IntervalType:String = null with get,set

        [<DataMember>]
        member val Group:String = null with get,set

        [<DataMember>]
        member val Notes:String = null with get,set

        [<DataMember>]
        member val Amt:Decimal = new Decimal() with get,set

        [<DataMember>]
        member val TimeInterval:Int32 = new Int32() with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type ShortTermRentalInventoryObj() = 
        [<DataMember>]
        member val Rates:ResizeArray<ShortTermRentalInventoryRate> = new ResizeArray<ShortTermRentalInventoryRate>() with get,set

        [<DataMember>]
        member val AvailableSerialPks:ResizeArray<Int64> = new ResizeArray<Int64>() with get,set

        [<DataMember>]
        member val SaqPk:Nullable<Int64> = new Nullable<Int64>() with get,set

        [<DataMember>]
        member val SkuPk:Nullable<Int64> = new Nullable<Int64>() with get,set

        [<DataMember>]
        member val PkhPk:Nullable<Int64> = new Nullable<Int64>() with get,set

        [<DataMember>]
        member val Sku:String = null with get,set

        [<DataMember>]
        member val Package:String = null with get,set

        [<DataMember>]
        member val InvType:String = null with get,set

        [<DataMember>]
        member val AvailableQty:Decimal = new Decimal() with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type ShortTermRentalInventoryResponse() = 
        inherit BaseResponse()
        [<DataMember>]
        member val Results:ResizeArray<ShortTermRentalInventoryObj> = new ResizeArray<ShortTermRentalInventoryObj>() with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type 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")>]
        member val ApiKey:String = null with get,set

        ///<summary>
        ///The OAuthToken token return by AeServices30
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="The OAuthToken token return by AeServices30", IsRequired=true, Name="OAuthToken", ParameterType="Header")>]
        member val OAuthToken:String = null with get,set

        ///<summary>
        ///The Device ID of the Mobile Device. Not used for non-mobile devices.
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="The Device ID of the Mobile Device. Not used for non-mobile devices.", Name="DeviceId", ParameterType="Header")>]
        member val DeviceId:String = null with get,set

        ///<summary>
        ///An identifier for your integration
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="An identifier for your integration", IsRequired=true, Name="AppId", ParameterType="Header")>]
        member val AppId:String = null with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type BaseSecureRequest() = 
        inherit BaseRequest()
        ///<summary>
        ///The Login Token return by the Security API. Required for secured calls.
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="The Login Token return by the Security API. Required for secured calls.", Name="Token", ParameterType="Header")>]
        member val Token:String = null with get,set

    ///<summary>
    ///ShortTermRentalInventoryRequires active-e Short Term Rental Service
    ///</summary>
    [<DataContract>]
    [<AllowNullLiteral>]
    type ShortTermRentalInventoryRequest() = 
        inherit 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")>]
        member val Item:String = null with get,set

        [<DataMember>]
        member val LocationCode:String = null with get,set

        ///<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")>]
        member val ItemPk:Nullable<Int64> = new Nullable<Int64>() with get,set

        ///<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")>]
        member val PkType:String = null with get,set

        ///<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")>]
        member val Category:Nullable<Int32> = new Nullable<Int32>() with get,set

        ///<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")>]
        member val SubCategory:Nullable<Int32> = new Nullable<Int32>() with get,set

F# 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>