AIM Web Services

GetStationsRequest

GetStations
Requires active-e Range Reservations Service

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

**GetStationsRequest** Parameters:
Name	Parameter	Data Type	Required	Description
LocationId	query	integer	No	If sent, only stations at the passed location will be returned.
GroupId	query	integer	No	If sent, only stations in the passed Station group will be returned
Acct	query	int?	No
GenerateAvailabilityCalendar	query	bool	No
AvailabilityCalendarDays	query	integer	No	If sent, the availability calendar will be for the next X days
AvailabilityCalendarDate	query	integer	No	If sent, the availability calendar will be for the sent date only
AvailabilityCalendarReservationLength	query	integer	No	If sent, the availability calendar will look for available slots of length X minutes. Uses the interval of the station group if not sent.

**BaseSecureRequest** Parameters:
Name	Parameter	Data Type	Required
Token	Header	string	No
DeviceId	Header	string	No
AppId	Header	string	Yes

**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	No

**GetStationsResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Stations	form	List<StationInfo>	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

**StationInfo** Parameters:
Name	Parameter	Data Type	Required
Id	form	long	No
Name	form	string	No
WebDescription	form	string	No
MaxUsers	form	int	No
Location	form	LocationInfo	No
CurrentStatus	form	string	No
Reservations	form	List<ReservationInfo>	No
AvailabilityCalendar	form	List<DateTime>	No
Topic	form	string	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

**ReservationInfo** Parameters:
Name	Parameter	Data Type	Required
Start	form	DateTime	No
End	form	DateTime	No
CustomerAcct	form	int?	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/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: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>

AIM Web Services

GetStationsRequest

GetStations Requires active-e Range Reservations Service

HTTP + XML

GetStations
Requires active-e Range Reservations Service