AIM Web Services

<back to all web services

GetStationsRequest

GetStations
Requires active-e Station Reservations Service

The following routes are available for this service:
GET/api/GetStations
"use strict";
export class BaseRequest {
    /** @param {{ApiKey?:string,OAuthToken?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description This is your AIM API Key provided by Tri-Tech */
    ApiKey;
    /** @type {string} */
    OAuthToken;
}
export class BaseSecureRequest extends BaseRequest {
    /** @param {{Token?:string,DeviceId?:string,AppId?:string,ApiKey?:string,OAuthToken?:string}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {string} */
    Token;
    /** @type {string} */
    DeviceId;
    /** @type {string} */
    AppId;
}
export class BaseResponseResult {
    /** @param {{StatusCode?:string,Login?:string,ErrorCode?:string,ErrorDisplayText?:string,ErrorMessage?:string,DomainName?:string,IpAddress?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    StatusCode;
    /** @type {string} */
    Login;
    /** @type {string} */
    ErrorCode;
    /** @type {string} */
    ErrorDisplayText;
    /** @type {string} */
    ErrorMessage;
    /** @type {string} */
    DomainName;
    /** @type {string} */
    IpAddress;
}
export class BaseResponse {
    /** @param {{Status?:BaseResponseResult}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {BaseResponseResult} */
    Status;
}
export class LocationInfo {
    /** @param {{Id?:number,Desc?:string,ShortDesc?:string,Region?:string,Latitude?:number,Longitude?:number,InStorePickup?:string,Active?:boolean,CashSaleAcct?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    Id;
    /** @type {string} */
    Desc;
    /** @type {string} */
    ShortDesc;
    /** @type {string} */
    Region;
    /** @type {number} */
    Latitude;
    /** @type {number} */
    Longitude;
    /** @type {string} */
    InStorePickup;
    /** @type {boolean} */
    Active;
    /** @type {?number} */
    CashSaleAcct;
}
export class ReservationInfo {
    /** @param {{Start?:string,End?:string,CustomerAcct?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Start;
    /** @type {string} */
    End;
    /** @type {?number} */
    CustomerAcct;
}
export class StationInfo {
    /** @param {{Id?:number,Name?:string,WebDescription?:string,MaxUsers?:number,Location?:LocationInfo,CurrentStatus?:string,Reservations?:ReservationInfo[],AvailabilityCalendar?:string[],Topic?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    Id;
    /** @type {string} */
    Name;
    /** @type {string} */
    WebDescription;
    /** @type {number} */
    MaxUsers;
    /** @type {LocationInfo} */
    Location;
    /** @type {string} */
    CurrentStatus;
    /** @type {ReservationInfo[]} */
    Reservations;
    /** @type {string[]} */
    AvailabilityCalendar;
    /** @type {string} */
    Topic;
}
export class GetStationsResponse extends BaseResponse {
    /** @param {{Stations?:StationInfo[],Status?:BaseResponseResult}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {StationInfo[]} */
    Stations;
}
export class GetStationsRequest extends BaseSecureRequest {
    /** @param {{LocationId?:number,GroupId?:number,Acct?:number,GenerateAvailabilityCalendar?:boolean,AvailabilityCalendarDays?:number,AvailabilityCalendarDate?:string,AvailabilityCalendarReservationLength?:number,Token?:string,DeviceId?:string,AppId?:string,ApiKey?:string,OAuthToken?:string}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /**
     * @type {?number}
     * @description If sent, only stations at the passed location will be returned. */
    LocationId;
    /**
     * @type {?number}
     * @description If sent, only stations in the passed Station group will be returned */
    GroupId;
    /** @type {?number} */
    Acct;
    /** @type {boolean} */
    GenerateAvailabilityCalendar;
    /**
     * @type {?number}
     * @description If sent, the availability calendar will be for the next X days */
    AvailabilityCalendarDays;
    /**
     * @type {?string}
     * @description If sent, the availability calendar will be for the sent date only */
    AvailabilityCalendarDate;
    /**
     * @type {?number}
     * @description If sent, the availability calendar will look for available slots of length X minutes. Uses the interval of the station group if not sent. */
    AvailabilityCalendarReservationLength;
}

JavaScript GetStationsRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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/json

HTTP/1.1 200 OK
Content-Type: application/json
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"}}