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
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; }
    }

}

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

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

        [DataMember]
        public virtual bool GenerateAvailabilityCalendar { 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")]
        public virtual int? AvailabilityCalendarDays { 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")]
        public virtual DateTime? AvailabilityCalendarDate { 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")]
        public virtual int? AvailabilityCalendarReservationLength { get; set; }
    }

    [DataContract]
    public partial class GetStationsResponse
        : BaseResponse
    {
        public GetStationsResponse()
        {
            Stations = new List<StationInfo>{};
        }

        [DataMember]
        public virtual List<StationInfo> Stations { get; set; }
        [DataContract]
        public partial class StationInfo
        {
            public StationInfo()
            {
                Reservations = new List<ReservationInfo>{};
                AvailabilityCalendar = new List<DateTime>{};
            }

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

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

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

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

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

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

            [DataMember]
            public virtual List<ReservationInfo> Reservations { get; set; }

            [DataMember]
            public virtual List<DateTime> AvailabilityCalendar { get; set; }

            [DataMember]
            public virtual string Topic { get; set; }
            [DataContract]
            public partial class ReservationInfo
            {
                [DataMember]
                public virtual DateTime Start { get; set; }

                [DataMember]
                public virtual DateTime End { get; set; }

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

        }

    }

}

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