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
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using AIM.WebService;

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 virtual string ApiKey { get; set; }

        [DataMember]
        [ApiMember(DataType="string", Name="OAuthToken", ParameterType="header")]
        public virtual string OAuthToken { get; set; }
    }

    [DataContract]
    public partial class BaseResponse
    {
        ///<summary>
        ///
        ///</summary>
        [DataMember]
        [ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")]
        public virtual BaseResponseResult Status { get; set; }
        [DataContract]
        public partial class BaseResponseResult
        {
            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", Name="StatusCode", ParameterType="body")]
            public virtual string StatusCode { get; set; }

            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", Name="Login", ParameterType="body")]
            public virtual string Login { get; set; }

            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", Name="ErrorCode", ParameterType="body")]
            public virtual string ErrorCode { get; set; }

            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", Name="ErrorDisplayText", ParameterType="body")]
            public virtual string ErrorDisplayText { get; set; }

            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", Name="ErrorMessage", ParameterType="body")]
            public virtual string ErrorMessage { get; set; }

            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="DomainName", ParameterType="body")]
            public virtual string DomainName { get; set; }

            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")]
            public virtual string IpAddress { get; set; }
        }

    }

    [DataContract]
    public partial class BaseSecureRequest
        : BaseRequest
    {
        ///<summary>
        ///
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="", Name="Token", ParameterType="Header")]
        public virtual string Token { get; set; }

        ///<summary>
        ///
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="", Name="DeviceId", ParameterType="Header")]
        public virtual string DeviceId { get; set; }

        ///<summary>
        ///
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="", IsRequired=true, Name="AppId", ParameterType="Header")]
        public virtual string AppId { get; set; }
    }

    [DataContract]
    public partial class PackageVariantItem
    {
        [DataMember]
        public virtual string Model { get; set; }

        [DataMember]
        public virtual string Sku { get; set; }
    }

    [DataContract]
    public partial class ShortTermRentalItem
    {
        public ShortTermRentalItem()
        {
            PackageVariantItems = new List<PackageVariantItem>{};
        }

        ///<summary>
        ///SasPk, SaqPk, or PkhPk
        ///</summary>
        [DataMember]
        [ApiMember(Description="SasPk, SaqPk, or PkhPk", IsRequired=true, Name="Pk", ParameterType="query")]
        public virtual long Pk { get; set; }

        ///<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 virtual string ItemType { get; set; }

        ///<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 virtual decimal? ItemQuantity { get; set; }

        ///<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 virtual decimal? ItemRate { get; set; }

        [DataMember]
        public virtual string Notes { get; set; }

        [DataMember]
        public virtual List<PackageVariantItem> PackageVariantItems { get; set; }
    }

    ///<summary>
    ///ShortTermRentalReservationRequires active-e Short Term Rental Service
    ///</summary>
    [DataContract]
    public partial class ShortTermRentalReservationRequest
        : BaseSecureRequest
    {
        public ShortTermRentalReservationRequest()
        {
            Items = new List<ShortTermRentalItem>{};
        }

        ///<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 virtual DateTime PickupDate { get; set; }

        ///<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 virtual DateTime ReturnDate { get; set; }

        ///<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 virtual int CustomerAcct { get; set; }

        [DataMember]
        public virtual List<ShortTermRentalItem> Items { get; set; }

        [DataMember]
        public virtual string Notes { get; set; }
    }

    [DataContract]
    public partial class ShortTermRentalReservationResponse
        : BaseResponse
    {
        [DataMember]
        public virtual string RefNumber { get; set; }
    }

}

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