| GET | /api/ShortTermRentalAvailability |
|---|
import java.math.*;
import java.util.*;
import net.servicestack.client.*;
public class dtos
{
/**
* ShortTermRentalAvailabilityRequires active-e Short Term Rental Service
*/
@DataContract
public static class ShortTermRentalAvailabilityRequest 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;
/**
* PK of the Scsaqty to lookup. Pass in SkuPk *OR* SasPK *OR* PkhPk *OR* Category and SubCategory
*/
@DataMember
@ApiMember(Description="PK of the Scsaqty to lookup. Pass in SkuPk *OR* SasPK *OR* PkhPk *OR* Category and SubCategory", Name="SaqPk", ParameterType="query")
public Long SaqPk = null;
/**
* PK of the Serial# to lookup. Pass in SkuPk *OR* SasPK *OR* PkhPk *OR* Category and SubCategory
*/
@DataMember
@ApiMember(Description="PK of the Serial# to lookup. Pass in SkuPk *OR* SasPK *OR* PkhPk *OR* Category and SubCategory", Name="SasPk", ParameterType="query")
public Long SasPk = null;
/**
* PK of the Package Deal to lookup. Pass in SkuPk *OR* SasPK *OR* PkhPk *OR* Category and SubCategory
*/
@DataMember
@ApiMember(Description="PK of the Package Deal to lookup. Pass in SkuPk *OR* SasPK *OR* PkhPk *OR* Category and SubCategory", Name="PkhPk", ParameterType="query")
public Long PkhPk = null;
/**
* Pass in SkuPk *OR* SasPK *OR* PkhPk *OR* Category and SubCategory
*/
@DataMember
@ApiMember(Description="Pass in SkuPk *OR* SasPK *OR* PkhPk *OR* Category and SubCategory", Name="Category", ParameterType="query")
public Integer Category = null;
/**
* Pass in SkuPk *OR* SasPK *OR* PkhPk *OR* Category and SubCategory
*/
@DataMember
@ApiMember(Description="Pass in SkuPk *OR* SasPK *OR* PkhPk *OR* Category and SubCategory", Name="SubCategory", ParameterType="query")
public Integer SubCategory = null;
/**
* Quantity of item required. Does not apply to serial#s.
*/
@DataMember
@ApiMember(Description="Quantity of item required. Does not apply to serial#s.", IsRequired=true, Name="ItemQuantity", ParameterType="query")
public BigDecimal ItemQuantity = null;
public Date getPickupDate() { return PickupDate; }
public ShortTermRentalAvailabilityRequest setPickupDate(Date value) { this.PickupDate = value; return this; }
public Date getReturnDate() { return ReturnDate; }
public ShortTermRentalAvailabilityRequest setReturnDate(Date value) { this.ReturnDate = value; return this; }
public Long getSaqPk() { return SaqPk; }
public ShortTermRentalAvailabilityRequest setSaqPk(Long value) { this.SaqPk = value; return this; }
public Long getSasPk() { return SasPk; }
public ShortTermRentalAvailabilityRequest setSasPk(Long value) { this.SasPk = value; return this; }
public Long getPkhPk() { return PkhPk; }
public ShortTermRentalAvailabilityRequest setPkhPk(Long value) { this.PkhPk = value; return this; }
public Integer getCategory() { return Category; }
public ShortTermRentalAvailabilityRequest setCategory(Integer value) { this.Category = value; return this; }
public Integer getSubCategory() { return SubCategory; }
public ShortTermRentalAvailabilityRequest setSubCategory(Integer value) { this.SubCategory = value; return this; }
public BigDecimal getItemQuantity() { return ItemQuantity; }
public ShortTermRentalAvailabilityRequest setItemQuantity(BigDecimal value) { this.ItemQuantity = 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 ShortTermRentalAvailabilityResponse extends BaseResponse
{
@DataMember
public Boolean IsAvailable = null;
@DataMember
public ArrayList<AvailableSku> AvailableSkus = null;
public Boolean getIsAvailable() { return IsAvailable; }
public ShortTermRentalAvailabilityResponse setIsAvailable(Boolean value) { this.IsAvailable = value; return this; }
public ArrayList<AvailableSku> getAvailableSkus() { return AvailableSkus; }
public ShortTermRentalAvailabilityResponse setAvailableSkus(ArrayList<AvailableSku> value) { this.AvailableSkus = 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; }
}
@DataContract
public static class AvailableSku
{
@DataMember
public Long SaqPk = null;
@DataMember
public String Sku = null;
@DataMember
public String Description = null;
public Long getSaqPk() { return SaqPk; }
public AvailableSku setSaqPk(Long value) { this.SaqPk = value; return this; }
public String getSku() { return Sku; }
public AvailableSku setSku(String value) { this.Sku = value; return this; }
public String getDescription() { return Description; }
public AvailableSku setDescription(String value) { this.Description = value; return this; }
}
}
Java ShortTermRentalAvailabilityRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /api/ShortTermRentalAvailability HTTP/1.1 Host: active-ewebservice.biz Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<ShortTermRentalAvailabilityResponse 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>
<AvailableSkus>
<AvailableSku>
<Description>String</Description>
<SaqPk>0</SaqPk>
<Sku>String</Sku>
</AvailableSku>
</AvailableSkus>
<IsAvailable>false</IsAvailable>
</ShortTermRentalAvailabilityResponse>