| GET | /api/GetStations |
|---|
| 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. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Token | Header | string | No | |
| DeviceId | Header | string | No | |
| AppId | Header | string | Yes |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ApiKey | header | string | Yes | This is your AIM API Key provided by Tri-Tech |
| OAuthToken | header | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Stations | form | List<StationInfo> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Status | body | BaseResponseResult | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| 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 |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| 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 |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| 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 |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| 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 .other suffix or ?format=other
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: text/jsonl
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length
{"Stations":[{"Id":0,"Name":"String","WebDescription":"String","MaxUsers":0,"Location":{"Id":0,"Desc":"String","ShortDesc":"String","Region":"String","Latitude":0,"Longitude":0,"InStorePickup":"String","Active":false,"CashSaleAcct":0},"CurrentStatus":"String","Reservations":[{"CustomerAcct":0}],"AvailabilityCalendar":["0001-01-01T00:00:00.0000000"],"Topic":"String"}],"Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}