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
namespace AIM

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<DataContract>]
    [<AllowNullLiteral>]
    type BaseResponseResult() = 
        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", Name="StatusCode", ParameterType="body")>]
        member val StatusCode:String = null with get,set

        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", Name="Login", ParameterType="body")>]
        member val Login:String = null with get,set

        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", Name="ErrorCode", ParameterType="body")>]
        member val ErrorCode:String = null with get,set

        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", Name="ErrorDisplayText", ParameterType="body")>]
        member val ErrorDisplayText:String = null with get,set

        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", Name="ErrorMessage", ParameterType="body")>]
        member val ErrorMessage:String = null with get,set

        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="DomainName", ParameterType="body")>]
        member val DomainName:String = null with get,set

        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")>]
        member val IpAddress:String = null with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type BaseResponse() = 
        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")>]
        member val Status:BaseResponseResult = null with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type LocationInfo() = 
        [<DataMember>]
        member val Id:Int64 = new Int64() with get,set

        [<DataMember>]
        member val Desc:String = null with get,set

        [<DataMember>]
        member val ShortDesc:String = null with get,set

        [<DataMember>]
        member val Region:String = null with get,set

        [<DataMember>]
        member val Latitude:Decimal = new Decimal() with get,set

        [<DataMember>]
        member val Longitude:Decimal = new Decimal() with get,set

        [<DataMember>]
        member val InStorePickup:String = null with get,set

        [<DataMember>]
        member val Active:Boolean = new Boolean() with get,set

        [<DataMember>]
        member val CashSaleAcct:Nullable<Int32> = new Nullable<Int32>() with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type ReservationInfo() = 
        [<DataMember>]
        member val Start:DateTime = new DateTime() with get,set

        [<DataMember>]
        member val End:DateTime = new DateTime() with get,set

        [<DataMember>]
        member val CustomerAcct:Nullable<Int32> = new Nullable<Int32>() with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type StationInfo() = 
        [<DataMember>]
        member val Id:Int64 = new Int64() with get,set

        [<DataMember>]
        member val Name:String = null with get,set

        [<DataMember>]
        member val WebDescription:String = null with get,set

        [<DataMember>]
        member val MaxUsers:Int32 = new Int32() with get,set

        [<DataMember>]
        member val Location:LocationInfo = null with get,set

        [<DataMember>]
        member val CurrentStatus:String = null with get,set

        [<DataMember>]
        member val Reservations:ResizeArray<ReservationInfo> = new ResizeArray<ReservationInfo>() with get,set

        [<DataMember>]
        member val AvailabilityCalendar:ResizeArray<DateTime> = new ResizeArray<DateTime>() with get,set

        [<DataMember>]
        member val Topic:String = null with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type GetStationsResponse() = 
        inherit BaseResponse()
        [<DataMember>]
        member val Stations:ResizeArray<StationInfo> = new ResizeArray<StationInfo>() with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type 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")>]
        member val ApiKey:String = null with get,set

        ///<summary>
        ///The OAuthToken token return by AeServices30
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="The OAuthToken token return by AeServices30", IsRequired=true, Name="OAuthToken", ParameterType="Header")>]
        member val OAuthToken:String = null with get,set

        ///<summary>
        ///The Device ID of the Mobile Device. Not used for non-mobile devices.
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="The Device ID of the Mobile Device. Not used for non-mobile devices.", Name="DeviceId", ParameterType="Header")>]
        member val DeviceId:String = null with get,set

        ///<summary>
        ///An identifier for your integration
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="An identifier for your integration", IsRequired=true, Name="AppId", ParameterType="Header")>]
        member val AppId:String = null with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type BaseSecureRequest() = 
        inherit BaseRequest()
        ///<summary>
        ///The Login Token return by the Security API. Required for secured calls.
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="The Login Token return by the Security API. Required for secured calls.", Name="Token", ParameterType="Header")>]
        member val Token:String = null with get,set

    ///<summary>
    ///GetStationsRequires active-e Station Reservations Service
    ///</summary>
    [<DataContract>]
    [<AllowNullLiteral>]
    type GetStationsRequest() = 
        inherit BaseSecureRequest()
        ///<summary>
        ///If sent, only stations at the passed location will be returned.
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="integer", Description="If sent, only stations at the passed location will be returned.", Format="int64", Name="LocationId", ParameterType="query")>]
        member val LocationId:Nullable<Int64> = new Nullable<Int64>() with get,set

        ///<summary>
        ///If sent, only stations in the passed Station group will be returned
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="integer", Description="If sent, only stations in the passed Station group will be returned", Format="int64", Name="GroupId", ParameterType="query")>]
        member val GroupId:Nullable<Int64> = new Nullable<Int64>() with get,set

        [<DataMember>]
        member val Acct:Nullable<Int32> = new Nullable<Int32>() with get,set

        [<DataMember>]
        member val GenerateAvailabilityCalendar:Boolean = new Boolean() with get,set

        ///<summary>
        ///If sent, the availability calendar will be for the next X days
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="integer", Description="If sent, the availability calendar will be for the next X days", Format="int64", Name="AvailabilityCalendarDays", ParameterType="query")>]
        member val AvailabilityCalendarDays:Nullable<Int32> = new Nullable<Int32>() with get,set

        ///<summary>
        ///If sent, the availability calendar will be for the sent date only
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="integer", Description="If sent, the availability calendar will be for the sent date only", Format="int64", Name="AvailabilityCalendarDate", ParameterType="query")>]
        member val AvailabilityCalendarDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set

        ///<summary>
        ///If sent, the availability calendar will look for available slots of length X minutes. Uses the interval of the station group if not sent.
        ///</summary>
        [<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")>]
        member val AvailabilityCalendarReservationLength:Nullable<Int32> = new Nullable<Int32>() with get,set

F# GetStationsRequest 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.

GET /api/GetStations HTTP/1.1 
Host: active-ewebservice.biz 
Accept: application/xml

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

<GetStationsResponse 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>
  <Stations>
    <GetStationsResponse.StationInfo>
      <AvailabilityCalendar xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:dateTime>0001-01-01T00:00:00</d4p1:dateTime>
      </AvailabilityCalendar>
      <CurrentStatus>String</CurrentStatus>
      <Id>0</Id>
      <Location xmlns:d4p1="http://schemas.datacontract.org/2004/07/AIM">
        <d4p1:Active>false</d4p1:Active>
        <d4p1:CashSaleAcct>0</d4p1:CashSaleAcct>
        <d4p1:Desc>String</d4p1:Desc>
        <d4p1:Id>0</d4p1:Id>
        <d4p1:InStorePickup>String</d4p1:InStorePickup>
        <d4p1:Latitude>0</d4p1:Latitude>
        <d4p1:Longitude>0</d4p1:Longitude>
        <d4p1:Region>String</d4p1:Region>
        <d4p1:ShortDesc>String</d4p1:ShortDesc>
      </Location>
      <MaxUsers>0</MaxUsers>
      <Name>String</Name>
      <Reservations>
        <GetStationsResponse.StationInfo.ReservationInfo>
          <CustomerAcct>0</CustomerAcct>
          <End>0001-01-01T00:00:00</End>
          <Start>0001-01-01T00:00:00</Start>
        </GetStationsResponse.StationInfo.ReservationInfo>
      </Reservations>
      <Topic>String</Topic>
      <WebDescription>String</WebDescription>
    </GetStationsResponse.StationInfo>
  </Stations>
</GetStationsResponse>