AIM Web Services

<back to all web services

ShortTermRentalAvailabilityRequest

ShortTermRentalAvailability
Requires active-e Short Term Rental Service

The following routes are available for this service:
GET/api/ShortTermRentalAvailability
import Foundation
import ServiceStack

/**
* ShortTermRentalAvailabilityRequires active-e Short Term Rental Service
*/
// @DataContract
public class ShortTermRentalAvailabilityRequest : 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 var pickupDate:Date

    /**
    * 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 var returnDate:Date

    /**
    * 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 var saqPk:Int?

    /**
    * 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 var sasPk:Int?

    /**
    * 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 var pkhPk:Int?

    /**
    * 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 var category:Int?

    /**
    * 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 var subCategory:Int?

    /**
    * 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 var itemQuantity:Double?

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case pickupDate
        case returnDate
        case saqPk
        case sasPk
        case pkhPk
        case category
        case subCategory
        case itemQuantity
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        pickupDate = try container.decodeIfPresent(Date.self, forKey: .pickupDate)
        returnDate = try container.decodeIfPresent(Date.self, forKey: .returnDate)
        saqPk = try container.decodeIfPresent(Int.self, forKey: .saqPk)
        sasPk = try container.decodeIfPresent(Int.self, forKey: .sasPk)
        pkhPk = try container.decodeIfPresent(Int.self, forKey: .pkhPk)
        category = try container.decodeIfPresent(Int.self, forKey: .category)
        subCategory = try container.decodeIfPresent(Int.self, forKey: .subCategory)
        itemQuantity = try container.decodeIfPresent(Double.self, forKey: .itemQuantity)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if pickupDate != nil { try container.encode(pickupDate, forKey: .pickupDate) }
        if returnDate != nil { try container.encode(returnDate, forKey: .returnDate) }
        if saqPk != nil { try container.encode(saqPk, forKey: .saqPk) }
        if sasPk != nil { try container.encode(sasPk, forKey: .sasPk) }
        if pkhPk != nil { try container.encode(pkhPk, forKey: .pkhPk) }
        if category != nil { try container.encode(category, forKey: .category) }
        if subCategory != nil { try container.encode(subCategory, forKey: .subCategory) }
        if itemQuantity != nil { try container.encode(itemQuantity, forKey: .itemQuantity) }
    }
}

// @DataContract
public class BaseSecureRequest : BaseRequest
{
    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="Token", ParameterType="Header")
    public var token:String

    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="DeviceId", ParameterType="Header")
    public var deviceId:String

    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="", IsRequired=true, Name="AppId", ParameterType="Header")
    public var appId:String

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case token
        case deviceId
        case appId
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        token = try container.decodeIfPresent(String.self, forKey: .token)
        deviceId = try container.decodeIfPresent(String.self, forKey: .deviceId)
        appId = try container.decodeIfPresent(String.self, forKey: .appId)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if token != nil { try container.encode(token, forKey: .token) }
        if deviceId != nil { try container.encode(deviceId, forKey: .deviceId) }
        if appId != nil { try container.encode(appId, forKey: .appId) }
    }
}

// @DataContract
public class BaseRequest : Codable
{
    /**
    * 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 var apiKey:String

    // @DataMember
    // @ApiMember(DataType="string", Name="OAuthToken", ParameterType="header")
    public var oAuthToken:String

    required public init(){}
}

// @DataContract
public class ShortTermRentalAvailabilityResponse : BaseResponse
{
    // @DataMember
    public var isAvailable:Bool

    // @DataMember
    public var availableSkus:[AvailableSku] = []

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case isAvailable
        case availableSkus
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        isAvailable = try container.decodeIfPresent(Bool.self, forKey: .isAvailable)
        availableSkus = try container.decodeIfPresent([AvailableSku].self, forKey: .availableSkus) ?? []
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if isAvailable != nil { try container.encode(isAvailable, forKey: .isAvailable) }
        if availableSkus.count > 0 { try container.encode(availableSkus, forKey: .availableSkus) }
    }
}

// @DataContract
public class BaseResponse : Codable
{
    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")
    public var status:BaseResponseResult

    required public init(){}
}

// @DataContract
public class BaseResponseResult : Codable
{
    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="StatusCode", ParameterType="body")
    public var statusCode:String

    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="Login", ParameterType="body")
    public var login:String

    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="ErrorCode", ParameterType="body")
    public var errorCode:String

    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="ErrorDisplayText", ParameterType="body")
    public var errorDisplayText:String

    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="ErrorMessage", ParameterType="body")
    public var errorMessage:String

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

    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")
    public var ipAddress:String

    required public init(){}
}

// @DataContract
public class AvailableSku : Codable
{
    // @DataMember
    public var saqPk:Int

    // @DataMember
    public var sku:String

    // @DataMember
    public var Description:String

    required public init(){}
}

Swift ShortTermRentalAvailabilityRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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/json

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

{"IsAvailable":false,"AvailableSkus":[{"SaqPk":0,"Sku":"String","Description":"String"}],"Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}