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

Namespace Global

    Namespace AIM

        <DataContract>
        Public Partial Class LocationInfo
            <DataMember>
            Public Overridable Property Id As Long

            <DataMember>
            Public Overridable Property Desc As String

            <DataMember>
            Public Overridable Property ShortDesc As String

            <DataMember>
            Public Overridable Property Region As String

            <DataMember>
            Public Overridable Property Latitude As Decimal

            <DataMember>
            Public Overridable Property Longitude As Decimal

            <DataMember>
            Public Overridable Property InStorePickup As String

            <DataMember>
            Public Overridable Property Active As Boolean

            <DataMember>
            Public Overridable Property CashSaleAcct As Nullable(Of Integer)
        End Class

        <DataContract>
        Public Partial Class StationGroupMembershipData
            Public Sub New()
                Levels = New List(Of StationGroupMembershipLevel)
            End Sub

            <DataMember>
            Public Overridable Property Levels As List(Of StationGroupMembershipLevel)
        End Class

        <DataContract>
        Public Partial Class StationGroupMembershipLevel
            <DataMember>
            Public Overridable Property Level As Integer

            <DataMember>
            Public Overridable Property DaysAhead As Integer

            <DataMember>
            Public Overridable Property AllowBooking As Boolean
        End Class
    End Namespace

    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 Overridable Property ApiKey As String

            <DataMember>
            <ApiMember(DataType:="string", Name:="OAuthToken", ParameterType:="header")>
            Public Overridable Property OAuthToken As String
        End Class

        <DataContract>
        Public Partial Class BaseResponse
            '''<Summary>
            '''
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="BaseResponseResult", Description:="", Name:="Status", ParameterType:="body")>
            Public Overridable Property Status As BaseResponseResult

            <DataContract>
            Public Partial Class BaseResponseResult
                '''<Summary>
                '''
                '''</Summary>
                <DataMember>
                <ApiMember(DataType:="string", Description:="", Name:="StatusCode", ParameterType:="body")>
                Public Overridable Property StatusCode As String

                '''<Summary>
                '''
                '''</Summary>
                <DataMember>
                <ApiMember(DataType:="string", Description:="", Name:="Login", ParameterType:="body")>
                Public Overridable Property Login As String

                '''<Summary>
                '''
                '''</Summary>
                <DataMember>
                <ApiMember(DataType:="string", Description:="", Name:="ErrorCode", ParameterType:="body")>
                Public Overridable Property ErrorCode As String

                '''<Summary>
                '''
                '''</Summary>
                <DataMember>
                <ApiMember(DataType:="string", Description:="", Name:="ErrorDisplayText", ParameterType:="body")>
                Public Overridable Property ErrorDisplayText As String

                '''<Summary>
                '''
                '''</Summary>
                <DataMember>
                <ApiMember(DataType:="string", Description:="", Name:="ErrorMessage", ParameterType:="body")>
                Public Overridable Property ErrorMessage As String

                '''<Summary>
                '''
                '''</Summary>
                <DataMember>
                <ApiMember(DataType:="string", Description:="", ExcludeInSchema:=true, Name:="DomainName", ParameterType:="body")>
                Public Overridable Property DomainName As String

                '''<Summary>
                '''
                '''</Summary>
                <DataMember>
                <ApiMember(DataType:="string", Description:="", ExcludeInSchema:=true, Name:="IPAddress", ParameterType:="body")>
                Public Overridable Property IpAddress As String
            End Class
        End Class

        <DataContract>
        Public Partial Class BaseSecureRequest
            Inherits BaseRequest
            '''<Summary>
            '''
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="string", Description:="", Name:="Token", ParameterType:="Header")>
            Public Overridable Property Token As String

            '''<Summary>
            '''
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="string", Description:="", Name:="DeviceId", ParameterType:="Header")>
            Public Overridable Property DeviceId As String

            '''<Summary>
            '''
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="string", Description:="", IsRequired:=true, Name:="AppId", ParameterType:="Header")>
            Public Overridable Property AppId As String
        End Class

        '''<Summary>
        '''GetStationGroupsRequires active-e Station Reservations Service
        '''</Summary>
        <DataContract>
        Public Partial Class GetStationGroupsRequest
            Inherits 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 Overridable Property LocationId As Nullable(Of Long)
        End Class

        <DataContract>
        Public Partial Class GetStationGroupsResponse
            Inherits BaseResponse
            Public Sub New()
                StationGroups = New List(Of StationGroupInfo)
            End Sub

            <DataMember>
            Public Overridable Property StationGroups As List(Of StationGroupInfo)

            <DataContract>
            Public Partial Class StationGroupInfo
                Public Sub New()
                    Weekdays = New List(Of WeekdayInfo)
                End Sub

                <DataMember>
                Public Overridable Property Id As Long

                <DataMember>
                Public Overridable Property Description As String

                <DataMember>
                Public Overridable Property WebDescription As String

                <DataMember>
                Public Overridable Property Topic As String

                <DataMember>
                Public Overridable Property Interval As Integer

                <DataMember>
                Public Overridable Property Buffer As Integer

                <DataMember>
                Public Overridable Property Location As LocationInfo

                <DataMember>
                Public Overridable Property Yards As Integer

                <DataMember>
                Public Overridable Property Weekdays As List(Of WeekdayInfo)

                <DataMember>
                Public Overridable Property MembershipData As StationGroupMembershipData
            End Class

            <DataContract>
            Public Partial Class WeekdayInfo
                <DataMember>
                Public Overridable Property Weekday As String

                <DataMember>
                Public Overridable Property WeekdayInt As Integer

                <DataMember>
                Public Overridable Property Open As Boolean

                <DataMember>
                Public Overridable Property OpenHour As Nullable(Of Integer)

                <DataMember>
                Public Overridable Property OpenMinute As Nullable(Of Integer)

                <DataMember>
                Public Overridable Property CloseHour As Nullable(Of Integer)

                <DataMember>
                Public Overridable Property CloseMinute As Nullable(Of Integer)
            End Class
        End Class
    End Namespace
End Namespace

VB.NET GetStationGroupsRequest 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/GetStationGroups HTTP/1.1 
Host: active-ewebservice.biz 
Accept: application/xml

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

<GetStationGroupsResponse 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>
  <StationGroups>
    <GetStationGroupsResponse.StationGroupInfo>
      <Buffer>0</Buffer>
      <Description>String</Description>
      <Id>0</Id>
      <Interval>0</Interval>
      <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>
      <MembershipData xmlns:d4p1="http://schemas.datacontract.org/2004/07/AIM">
        <d4p1:Levels>
          <d4p1:StationGroupMembershipLevel>
            <d4p1:AllowBooking>false</d4p1:AllowBooking>
            <d4p1:DaysAhead>0</d4p1:DaysAhead>
            <d4p1:Level>0</d4p1:Level>
          </d4p1:StationGroupMembershipLevel>
        </d4p1:Levels>
      </MembershipData>
      <Topic>String</Topic>
      <WebDescription>String</WebDescription>
      <Weekdays>
        <GetStationGroupsResponse.WeekdayInfo>
          <CloseHour>0</CloseHour>
          <CloseMinute>0</CloseMinute>
          <Open>false</Open>
          <OpenHour>0</OpenHour>
          <OpenMinute>0</OpenMinute>
          <Weekday>String</Weekday>
          <WeekdayInt>0</WeekdayInt>
        </GetStationGroupsResponse.WeekdayInfo>
      </Weekdays>
      <Yards>0</Yards>
    </GetStationGroupsResponse.StationGroupInfo>
  </StationGroups>
</GetStationGroupsResponse>