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
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using AIM.WebService;
using AIM;

namespace AIM
{
    [DataContract]
    public partial class LocationInfo
    {
        [DataMember]
        public virtual long Id { get; set; }

        [DataMember]
        public virtual string Desc { get; set; }

        [DataMember]
        public virtual string ShortDesc { get; set; }

        [DataMember]
        public virtual string Region { get; set; }

        [DataMember]
        public virtual decimal Latitude { get; set; }

        [DataMember]
        public virtual decimal Longitude { get; set; }

        [DataMember]
        public virtual string InStorePickup { get; set; }

        [DataMember]
        public virtual bool Active { get; set; }

        [DataMember]
        public virtual int? CashSaleAcct { get; set; }
    }

    [DataContract]
    public partial class StationGroupMembershipData
    {
        public StationGroupMembershipData()
        {
            Levels = new List<StationGroupMembershipLevel>{};
        }

        [DataMember]
        public virtual List<StationGroupMembershipLevel> Levels { get; set; }
    }

    [DataContract]
    public partial class StationGroupMembershipLevel
    {
        [DataMember]
        public virtual int Level { get; set; }

        [DataMember]
        public virtual int DaysAhead { get; set; }

        [DataMember]
        public virtual bool AllowBooking { get; set; }
    }

}

namespace AIM.WebService
{
    [DataContract]
    public partial class 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")]
        public virtual string ApiKey { get; set; }

        [DataMember]
        [ApiMember(DataType="string", Name="OAuthToken", ParameterType="header")]
        public virtual string OAuthToken { get; set; }
    }

    [DataContract]
    public partial class BaseResponse
    {
        ///<summary>
        ///
        ///</summary>
        [DataMember]
        [ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")]
        public virtual BaseResponseResult Status { get; set; }
        [DataContract]
        public partial class BaseResponseResult
        {
            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", Name="StatusCode", ParameterType="body")]
            public virtual string StatusCode { get; set; }

            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", Name="Login", ParameterType="body")]
            public virtual string Login { get; set; }

            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", Name="ErrorCode", ParameterType="body")]
            public virtual string ErrorCode { get; set; }

            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", Name="ErrorDisplayText", ParameterType="body")]
            public virtual string ErrorDisplayText { get; set; }

            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", Name="ErrorMessage", ParameterType="body")]
            public virtual string ErrorMessage { get; set; }

            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="DomainName", ParameterType="body")]
            public virtual string DomainName { get; set; }

            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")]
            public virtual string IpAddress { get; set; }
        }

    }

    [DataContract]
    public partial class BaseSecureRequest
        : BaseRequest
    {
        ///<summary>
        ///
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="", Name="Token", ParameterType="Header")]
        public virtual string Token { get; set; }

        ///<summary>
        ///
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="", Name="DeviceId", ParameterType="Header")]
        public virtual string DeviceId { get; set; }

        ///<summary>
        ///
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="", IsRequired=true, Name="AppId", ParameterType="Header")]
        public virtual string AppId { get; set; }
    }

    ///<summary>
    ///GetStationGroupsRequires active-e Station Reservations Service
    ///</summary>
    [DataContract]
    public partial class GetStationGroupsRequest
        : 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")]
        public virtual long? LocationId { get; set; }
    }

    [DataContract]
    public partial class GetStationGroupsResponse
        : BaseResponse
    {
        public GetStationGroupsResponse()
        {
            StationGroups = new List<StationGroupInfo>{};
        }

        [DataMember]
        public virtual List<StationGroupInfo> StationGroups { get; set; }
        [DataContract]
        public partial class StationGroupInfo
        {
            public StationGroupInfo()
            {
                Weekdays = new List<WeekdayInfo>{};
            }

            [DataMember]
            public virtual long Id { get; set; }

            [DataMember]
            public virtual string Description { get; set; }

            [DataMember]
            public virtual string WebDescription { get; set; }

            [DataMember]
            public virtual string Topic { get; set; }

            [DataMember]
            public virtual int Interval { get; set; }

            [DataMember]
            public virtual int Buffer { get; set; }

            [DataMember]
            public virtual LocationInfo Location { get; set; }

            [DataMember]
            public virtual int Yards { get; set; }

            [DataMember]
            public virtual List<WeekdayInfo> Weekdays { get; set; }

            [DataMember]
            public virtual StationGroupMembershipData MembershipData { get; set; }
        }

        [DataContract]
        public partial class WeekdayInfo
        {
            [DataMember]
            public virtual string Weekday { get; set; }

            [DataMember]
            public virtual int WeekdayInt { get; set; }

            [DataMember]
            public virtual bool Open { get; set; }

            [DataMember]
            public virtual int? OpenHour { get; set; }

            [DataMember]
            public virtual int? OpenMinute { get; set; }

            [DataMember]
            public virtual int? CloseHour { get; set; }

            [DataMember]
            public virtual int? CloseMinute { get; set; }
        }

    }

}

C# 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"}}