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.*;

public class dtos
{

    /**
    * ShortTermRentalReservationRequires active-e Short Term Rental Service
    */
    @DataContract
    public static class ShortTermRentalReservationRequest extends 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")
        public Date PickupDate = 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")
        public Date ReturnDate = null;

        /**
        * Account of the customer making the reservation
        */
        @DataMember
        @ApiMember(Description="Account of the customer making the reservation", IsRequired=true, Name="CustomerAcct", ParameterType="query")
        public Integer CustomerAcct = null;

        @DataMember
        public ArrayList<ShortTermRentalItem> Items = null;

        @DataMember
        public String Notes = null;
        
        public Date getPickupDate() { return PickupDate; }
        public ShortTermRentalReservationRequest setPickupDate(Date value) { this.PickupDate = value; return this; }
        public Date getReturnDate() { return ReturnDate; }
        public ShortTermRentalReservationRequest setReturnDate(Date value) { this.ReturnDate = value; return this; }
        public Integer getCustomerAcct() { return CustomerAcct; }
        public ShortTermRentalReservationRequest setCustomerAcct(Integer value) { this.CustomerAcct = value; return this; }
        public ArrayList<ShortTermRentalItem> getItems() { return Items; }
        public ShortTermRentalReservationRequest setItems(ArrayList<ShortTermRentalItem> value) { this.Items = value; return this; }
        public String getNotes() { return Notes; }
        public ShortTermRentalReservationRequest setNotes(String value) { this.Notes = value; return this; }
    }

    @DataContract
    public static class BaseSecureRequest extends BaseRequest
    {
        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="string", Description="", Name="Token", ParameterType="Header")
        public String Token = null;

        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="string", Description="", Name="DeviceId", ParameterType="Header")
        public String DeviceId = null;

        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="string", Description="", IsRequired=true, Name="AppId", ParameterType="Header")
        public String AppId = null;
        
        public String getToken() { return Token; }
        public BaseSecureRequest setToken(String value) { this.Token = value; return this; }
        public String getDeviceId() { return DeviceId; }
        public BaseSecureRequest setDeviceId(String value) { this.DeviceId = value; return this; }
        public String getAppId() { return AppId; }
        public BaseSecureRequest setAppId(String value) { this.AppId = value; return this; }
    }

    @DataContract
    public static 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")
        public String ApiKey = null;

        @DataMember
        @ApiMember(DataType="string", Name="OAuthToken", ParameterType="header")
        public String OAuthToken = null;
        
        public String getApiKey() { return ApiKey; }
        public BaseRequest setApiKey(String value) { this.ApiKey = value; return this; }
        public String getOAuthToken() { return OAuthToken; }
        public BaseRequest setOAuthToken(String value) { this.OAuthToken = value; return this; }
    }

    @DataContract
    public static class ShortTermRentalItem
    {
        /**
        * SasPk, SaqPk, or PkhPk
        */
        @DataMember
        @ApiMember(Description="SasPk, SaqPk, or PkhPk", IsRequired=true, Name="Pk", ParameterType="query")
        public Long Pk = 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")
        public String ItemType = 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")
        public BigDecimal ItemQuantity = 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")
        public BigDecimal ItemRate = null;

        @DataMember
        public String Notes = null;

        @DataMember
        public ArrayList<PackageVariantItem> PackageVariantItems = null;
        
        public Long getPk() { return Pk; }
        public ShortTermRentalItem setPk(Long value) { this.Pk = value; return this; }
        public String getItemType() { return ItemType; }
        public ShortTermRentalItem setItemType(String value) { this.ItemType = value; return this; }
        public BigDecimal getItemQuantity() { return ItemQuantity; }
        public ShortTermRentalItem setItemQuantity(BigDecimal value) { this.ItemQuantity = value; return this; }
        public BigDecimal getItemRate() { return ItemRate; }
        public ShortTermRentalItem setItemRate(BigDecimal value) { this.ItemRate = value; return this; }
        public String getNotes() { return Notes; }
        public ShortTermRentalItem setNotes(String value) { this.Notes = value; return this; }
        public ArrayList<PackageVariantItem> getPackageVariantItems() { return PackageVariantItems; }
        public ShortTermRentalItem setPackageVariantItems(ArrayList<PackageVariantItem> value) { this.PackageVariantItems = value; return this; }
    }

    @DataContract
    public static class PackageVariantItem
    {
        @DataMember
        public String Model = null;

        @DataMember
        public String Sku = null;
        
        public String getModel() { return Model; }
        public PackageVariantItem setModel(String value) { this.Model = value; return this; }
        public String getSku() { return Sku; }
        public PackageVariantItem setSku(String value) { this.Sku = value; return this; }
    }

    @DataContract
    public static class ShortTermRentalReservationResponse extends BaseResponse
    {
        @DataMember
        public String RefNumber = null;
        
        public String getRefNumber() { return RefNumber; }
        public ShortTermRentalReservationResponse setRefNumber(String value) { this.RefNumber = value; return this; }
    }

    @DataContract
    public static class BaseResponse
    {
        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")
        public BaseResponseResult Status = null;
        
        public BaseResponseResult getStatus() { return Status; }
        public BaseResponse setStatus(BaseResponseResult value) { this.Status = value; return this; }
    }

    @DataContract
    public static class BaseResponseResult
    {
        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="string", Description="", Name="StatusCode", ParameterType="body")
        public String StatusCode = null;

        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="string", Description="", Name="Login", ParameterType="body")
        public String Login = null;

        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="string", Description="", Name="ErrorCode", ParameterType="body")
        public String ErrorCode = null;

        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="string", Description="", Name="ErrorDisplayText", ParameterType="body")
        public String ErrorDisplayText = null;

        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="string", Description="", Name="ErrorMessage", ParameterType="body")
        public String ErrorMessage = null;

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

        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")
        public String IpAddress = null;
        
        public String getStatusCode() { return StatusCode; }
        public BaseResponseResult setStatusCode(String value) { this.StatusCode = value; return this; }
        public String getLogin() { return Login; }
        public BaseResponseResult setLogin(String value) { this.Login = value; return this; }
        public String getErrorCode() { return ErrorCode; }
        public BaseResponseResult setErrorCode(String value) { this.ErrorCode = value; return this; }
        public String getErrorDisplayText() { return ErrorDisplayText; }
        public BaseResponseResult setErrorDisplayText(String value) { this.ErrorDisplayText = value; return this; }
        public String getErrorMessage() { return ErrorMessage; }
        public BaseResponseResult setErrorMessage(String value) { this.ErrorMessage = value; return this; }
        public String getDomainName() { return DomainName; }
        public BaseResponseResult setDomainName(String value) { this.DomainName = value; return this; }
        public String getIpAddress() { return IpAddress; }
        public BaseResponseResult setIpAddress(String value) { this.IpAddress = value; return this; }
    }

}

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