AIM Web Services

<back to all web services

GetStationGroupsRequest

GetStationGroups
Requires active-e Station Reservations Service

The following routes are available for this service:
GET/api/GetStationGroups
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 WeekdayInfo() = 
        [<DataMember>]
        member val Weekday:String = null with get,set

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

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

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

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

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

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

    [<DataContract>]
    [<AllowNullLiteral>]
    type StationGroupMembershipLevel() = 
        [<DataMember>]
        member val Level:Int32 = new Int32() with get,set

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

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

    [<DataContract>]
    [<AllowNullLiteral>]
    type StationGroupMembershipData() = 
        [<DataMember>]
        member val Levels:ResizeArray<StationGroupMembershipLevel> = new ResizeArray<StationGroupMembershipLevel>() with get,set

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

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

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

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

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

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

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

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

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

        [<DataMember>]
        member val MembershipData:StationGroupMembershipData = null with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type GetStationGroupsResponse() = 
        inherit BaseResponse()
        [<DataMember>]
        member val StationGroups:ResizeArray<StationGroupInfo> = new ResizeArray<StationGroupInfo>() 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

        [<DataMember>]
        [<ApiMember(DataType="string", Name="OAuthToken", ParameterType="header")>]
        member val OAuthToken:String = null with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type BaseSecureRequest() = 
        inherit BaseRequest()
        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", Name="Token", ParameterType="Header")>]
        member val Token:String = null with get,set

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

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

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

F# GetStationGroupsRequest 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/GetStationGroups HTTP/1.1 
Host: active-ewebservice.biz 
Accept: application/json

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

{"StationGroups":[{"Id":0,"Description":"String","WebDescription":"String","Topic":"String","Interval":0,"Buffer":0,"Location":{"Id":0,"Desc":"String","ShortDesc":"String","Region":"String","Latitude":0,"Longitude":0,"InStorePickup":"String","Active":false,"CashSaleAcct":0},"Yards":0,"Weekdays":[{"Weekday":"String","WeekdayInt":0,"Open":false,"OpenHour":0,"OpenMinute":0,"CloseHour":0,"CloseMinute":0}],"MembershipData":{"Levels":[{"Level":0,"DaysAhead":0,"AllowBooking":false}]}}],"Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}