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
import java.math.*
import java.util.*
import net.servicestack.client.*


/**
* GetStationGroupsRequires active-e Station Reservations Service
*/
@DataContract
open class GetStationGroupsRequest : BaseSecureRequest()
{
    /**
    * If sent, only station groups at the passed location will be returned.
    */
    @DataMember
    @ApiMember(DataType="integer", Description="If sent, only station groups at the passed location will be returned.", Format="int64", Name="LocationId", ParameterType="query")
    var LocationId:Long? = null
}

@DataContract
open class BaseSecureRequest : BaseRequest()
{
    /**
    * The Login Token return by the Security API. Required for secured calls.
    */
    @DataMember
    @ApiMember(DataType="string", Description="The Login Token return by the Security API. Required for secured calls.", Name="Token", ParameterType="Header")
    var Token:String? = null
}

@DataContract
open class BaseRequest
{
    /**
    * This is your AIM API Key provided by Tri-Tech
    */
    @DataMember
    @ApiMember(DataType="string", Description="This is your AIM API Key provided by Tri-Tech", IsRequired=true, Name="ApiKey", ParameterType="Header")
    var ApiKey:String? = null

    /**
    * The OAuthToken token return by AeServices30
    */
    @DataMember
    @ApiMember(DataType="string", Description="The OAuthToken token return by AeServices30", IsRequired=true, Name="OAuthToken", ParameterType="Header")
    var OAuthToken:String? = null

    /**
    * The Device ID of the Mobile Device. Not used for non-mobile devices.
    */
    @DataMember
    @ApiMember(DataType="string", Description="The Device ID of the Mobile Device. Not used for non-mobile devices.", Name="DeviceId", ParameterType="Header")
    var DeviceId:String? = null

    /**
    * An identifier for your integration
    */
    @DataMember
    @ApiMember(DataType="string", Description="An identifier for your integration", IsRequired=true, Name="AppId", ParameterType="Header")
    var AppId:String? = null
}

@DataContract
open class GetStationGroupsResponse : BaseResponse()
{
    @DataMember
    var StationGroups:ArrayList<StationGroupInfo> = ArrayList<StationGroupInfo>()
}

@DataContract
open class BaseResponse
{
    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")
    var Status:BaseResponseResult? = null
}

@DataContract
open class BaseResponseResult
{
    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", Name="StatusCode", ParameterType="body")
    var StatusCode:String? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", Name="Login", ParameterType="body")
    var Login:String? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", Name="ErrorCode", ParameterType="body")
    var ErrorCode:String? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", Name="ErrorDisplayText", ParameterType="body")
    var ErrorDisplayText:String? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", Name="ErrorMessage", ParameterType="body")
    var ErrorMessage:String? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="DomainName", ParameterType="body")
    var DomainName:String? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")
    var IpAddress:String? = null
}

@DataContract
open class StationGroupInfo
{
    @DataMember
    var Id:Long? = null

    @DataMember
    var Description:String? = null

    @DataMember
    var WebDescription:String? = null

    @DataMember
    var Topic:String? = null

    @DataMember
    var Interval:Int? = null

    @DataMember
    var Buffer:Int? = null

    @DataMember
    var Location:LocationInfo? = null

    @DataMember
    var Yards:Int? = null

    @DataMember
    var Weekdays:ArrayList<WeekdayInfo> = ArrayList<WeekdayInfo>()

    @DataMember
    var MembershipData:StationGroupMembershipData? = null
}

@DataContract
open class LocationInfo
{
    @DataMember
    var Id:Long? = null

    @DataMember
    var Desc:String? = null

    @DataMember
    var ShortDesc:String? = null

    @DataMember
    var Region:String? = null

    @DataMember
    var Latitude:BigDecimal? = null

    @DataMember
    var Longitude:BigDecimal? = null

    @DataMember
    var InStorePickup:String? = null

    @DataMember
    var Active:Boolean? = null

    @DataMember
    var CashSaleAcct:Int? = null
}

@DataContract
open class WeekdayInfo
{
    @DataMember
    var Weekday:String? = null

    @DataMember
    var WeekdayInt:Int? = null

    @DataMember
    var Open:Boolean? = null

    @DataMember
    var OpenHour:Int? = null

    @DataMember
    var OpenMinute:Int? = null

    @DataMember
    var CloseHour:Int? = null

    @DataMember
    var CloseMinute:Int? = null
}

@DataContract
open class StationGroupMembershipData
{
    @DataMember
    var Levels:ArrayList<StationGroupMembershipLevel> = ArrayList<StationGroupMembershipLevel>()
}

@DataContract
open class StationGroupMembershipLevel
{
    @DataMember
    var Level:Int? = null

    @DataMember
    var DaysAhead:Int? = null

    @DataMember
    var AllowBooking:Boolean? = null
}

Kotlin 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>