AIM Web Services

<back to all web services

GetStationsRequest

GetStations
Requires active-e Station Reservations Service

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

/**
* GetStationsRequires active-e Station Reservations Service
*/
// @DataContract
public class GetStationsRequest : BaseSecureRequest
{
    /**
    * If sent, only stations at the passed location will be returned.
    */
    // @DataMember
    // @ApiMember(DataType="integer", Description="If sent, only stations at the passed location will be returned.", Format="int64", Name="LocationId", ParameterType="query")
    public var locationId:Int?

    /**
    * If sent, only stations in the passed Station group will be returned
    */
    // @DataMember
    // @ApiMember(DataType="integer", Description="If sent, only stations in the passed Station group will be returned", Format="int64", Name="GroupId", ParameterType="query")
    public var groupId:Int?

    // @DataMember
    public var acct:Int?

    // @DataMember
    public var generateAvailabilityCalendar:Bool

    /**
    * If sent, the availability calendar will be for the next X days
    */
    // @DataMember
    // @ApiMember(DataType="integer", Description="If sent, the availability calendar will be for the next X days", Format="int64", Name="AvailabilityCalendarDays", ParameterType="query")
    public var availabilityCalendarDays:Int?

    /**
    * If sent, the availability calendar will be for the sent date only
    */
    // @DataMember
    // @ApiMember(DataType="integer", Description="If sent, the availability calendar will be for the sent date only", Format="int64", Name="AvailabilityCalendarDate", ParameterType="query")
    public var availabilityCalendarDate:Date?

    /**
    * If sent, the availability calendar will look for available slots of length X minutes. Uses the interval of the station group if not sent.
    */
    // @DataMember
    // @ApiMember(DataType="integer", Description="If sent, the availability calendar will look for available slots of length X minutes. Uses the interval of the station group if not sent.", Format="int64", Name="AvailabilityCalendarReservationLength", ParameterType="query")
    public var availabilityCalendarReservationLength:Int?

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

    private enum CodingKeys : String, CodingKey {
        case locationId
        case groupId
        case acct
        case generateAvailabilityCalendar
        case availabilityCalendarDays
        case availabilityCalendarDate
        case availabilityCalendarReservationLength
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        locationId = try container.decodeIfPresent(Int.self, forKey: .locationId)
        groupId = try container.decodeIfPresent(Int.self, forKey: .groupId)
        acct = try container.decodeIfPresent(Int.self, forKey: .acct)
        generateAvailabilityCalendar = try container.decodeIfPresent(Bool.self, forKey: .generateAvailabilityCalendar)
        availabilityCalendarDays = try container.decodeIfPresent(Int.self, forKey: .availabilityCalendarDays)
        availabilityCalendarDate = try container.decodeIfPresent(Date.self, forKey: .availabilityCalendarDate)
        availabilityCalendarReservationLength = try container.decodeIfPresent(Int.self, forKey: .availabilityCalendarReservationLength)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if locationId != nil { try container.encode(locationId, forKey: .locationId) }
        if groupId != nil { try container.encode(groupId, forKey: .groupId) }
        if acct != nil { try container.encode(acct, forKey: .acct) }
        if generateAvailabilityCalendar != nil { try container.encode(generateAvailabilityCalendar, forKey: .generateAvailabilityCalendar) }
        if availabilityCalendarDays != nil { try container.encode(availabilityCalendarDays, forKey: .availabilityCalendarDays) }
        if availabilityCalendarDate != nil { try container.encode(availabilityCalendarDate, forKey: .availabilityCalendarDate) }
        if availabilityCalendarReservationLength != nil { try container.encode(availabilityCalendarReservationLength, forKey: .availabilityCalendarReservationLength) }
    }
}

// @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 GetStationsResponse : BaseResponse
{
    // @DataMember
    public var stations:[StationInfo] = []

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

    private enum CodingKeys : String, CodingKey {
        case stations
    }

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

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

// @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 StationInfo : Codable
{
    // @DataMember
    public var id:Int

    // @DataMember
    public var name:String

    // @DataMember
    public var webDescription:String

    // @DataMember
    public var maxUsers:Int

    // @DataMember
    public var location:LocationInfo

    // @DataMember
    public var currentStatus:String

    // @DataMember
    public var reservations:[ReservationInfo] = []

    // @DataMember
    public var availabilityCalendar:[Date] = []

    // @DataMember
    public var topic:String

    required public init(){}
}

// @DataContract
public class LocationInfo : Codable
{
    // @DataMember
    public var id:Int

    // @DataMember
    public var desc:String

    // @DataMember
    public var shortDesc:String

    // @DataMember
    public var region:String

    // @DataMember
    public var latitude:Double

    // @DataMember
    public var longitude:Double

    // @DataMember
    public var inStorePickup:String

    // @DataMember
    public var active:Bool

    // @DataMember
    public var cashSaleAcct:Int?

    required public init(){}
}

// @DataContract
public class ReservationInfo : Codable
{
    // @DataMember
    public var start:Date

    // @DataMember
    public var end:Date

    // @DataMember
    public var customerAcct:Int?

    required public init(){}
}

Swift GetStationsRequest 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/GetStations HTTP/1.1 
Host: active-ewebservice.biz 
Accept: application/json

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

{"Stations":[{"Id":0,"Name":"String","WebDescription":"String","MaxUsers":0,"Location":{"Id":0,"Desc":"String","ShortDesc":"String","Region":"String","Latitude":0,"Longitude":0,"InStorePickup":"String","Active":false,"CashSaleAcct":0},"CurrentStatus":"String","Reservations":[{"CustomerAcct":0}],"AvailabilityCalendar":["0001-01-01T00:00:00.0000000"],"Topic":"String"}],"Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}