AIM Web Services

GetStationGroupsRequest

GetStationGroups
Requires active-e Station Reservations Service

The following routes are available for this service:
GET	/api/GetStationGroups

**GetStationGroupsRequest** Parameters:
Name	Parameter	Data Type	Required	Description
LocationId	query	integer	No	If sent, only station groups at the passed location will be returned.

**BaseSecureRequest** Parameters:
Name	Parameter	Data Type	Required	Description
Token	Header	string	No	The Login Token return by the Security API. Required for secured calls.

**BaseRequest** Parameters:
Name	Parameter	Data Type	Required	Description
ApiKey	Header	string	Yes	This is your AIM API Key provided by Tri-Tech
OAuthToken	Header	string	Yes	The OAuthToken token return by AeServices30
DeviceId	Header	string	No	The Device ID of the Mobile Device. Not used for non-mobile devices.
AppId	Header	string	Yes	An identifier for your integration

**GetStationGroupsResponse** Parameters:
Name	Parameter	Data Type	Required	Description
StationGroups	form	List<StationGroupInfo>	No

**BaseResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Status	body	BaseResponseResult	No

**BaseResponseResult** Parameters:
Name	Parameter	Data Type	Required
StatusCode	body	string	No
Login	body	string	No
ErrorCode	body	string	No
ErrorDisplayText	body	string	No
ErrorMessage	body	string	No
DomainName	body	string	No
IpAddress	body	string	No

**StationGroupInfo** Parameters:
Name	Parameter	Data Type	Required
Id	form	long	No
Description	form	string	No
WebDescription	form	string	No
Topic	form	string	No
Interval	form	int	No
Buffer	form	int	No
Location	form	LocationInfo	No
Yards	form	int	No
Weekdays	form	List<WeekdayInfo>	No
MembershipData	form	StationGroupMembershipData	No

**LocationInfo** Parameters:
Name	Parameter	Data Type	Required
Id	form	long	No
Desc	form	string	No
ShortDesc	form	string	No
Region	form	string	No
Latitude	form	decimal	No
Longitude	form	decimal	No
InStorePickup	form	string	No
Active	form	bool	No
CashSaleAcct	form	int?	No

**WeekdayInfo** Parameters:
Name	Parameter	Data Type	Required
Weekday	form	string	No
WeekdayInt	form	int	No
Open	form	bool	No
OpenHour	form	int?	No
OpenMinute	form	int?	No
CloseHour	form	int?	No
CloseMinute	form	int?	No

**StationGroupMembershipData** Parameters:
Name	Parameter	Data Type	Required	Description
Levels	form	List<StationGroupMembershipLevel>	No

**StationGroupMembershipLevel** Parameters:
Name	Parameter	Data Type	Required
Level	form	int	No
DaysAhead	form	int	No
AllowBooking	form	bool	No

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>

AIM Web Services

GetStationGroupsRequest

GetStationGroups Requires active-e Station Reservations Service

HTTP + XML

GetStationGroups
Requires active-e Station Reservations Service