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
"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 WeekdayInfo {
    /** @param {{Weekday?:string,WeekdayInt?:number,Open?:boolean,OpenHour?:number,OpenMinute?:number,CloseHour?:number,CloseMinute?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Weekday;
    /** @type {number} */
    WeekdayInt;
    /** @type {boolean} */
    Open;
    /** @type {?number} */
    OpenHour;
    /** @type {?number} */
    OpenMinute;
    /** @type {?number} */
    CloseHour;
    /** @type {?number} */
    CloseMinute;
}
export class StationGroupMembershipLevel {
    /** @param {{Level?:number,DaysAhead?:number,AllowBooking?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    Level;
    /** @type {number} */
    DaysAhead;
    /** @type {boolean} */
    AllowBooking;
}
export class StationGroupMembershipData {
    /** @param {{Levels?:StationGroupMembershipLevel[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {StationGroupMembershipLevel[]} */
    Levels;
}
export class StationGroupInfo {
    /** @param {{Id?:number,Description?:string,WebDescription?:string,Topic?:string,Interval?:number,Buffer?:number,Location?:LocationInfo,Yards?:number,Weekdays?:WeekdayInfo[],MembershipData?:StationGroupMembershipData}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    Id;
    /** @type {string} */
    Description;
    /** @type {string} */
    WebDescription;
    /** @type {string} */
    Topic;
    /** @type {number} */
    Interval;
    /** @type {number} */
    Buffer;
    /** @type {LocationInfo} */
    Location;
    /** @type {number} */
    Yards;
    /** @type {WeekdayInfo[]} */
    Weekdays;
    /** @type {StationGroupMembershipData} */
    MembershipData;
}
export class GetStationGroupsResponse extends BaseResponse {
    /** @param {{StationGroups?:StationGroupInfo[],Status?:BaseResponseResult}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {StationGroupInfo[]} */
    StationGroups;
}
export class GetStationGroupsRequest extends BaseSecureRequest {
    /** @param {{LocationId?: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 station groups at the passed location will be returned. */
    LocationId;
}

JavaScript GetStationGroupsRequest DTOs

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

HTTP + OTHER

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: text/jsonl

HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"StationGroups":[{"Id":0,"Description":"String","WebDescription":"String","Topic":"String","Interval":0,"Buffer":0,"Location":{"Id":0,"Desc":"String","ShortDesc":"String","Region":"String","Latitude":0,"Longitude":0,"InStorePickup":"String","Active":false,"CashSaleAcct":0},"Yards":0,"Weekdays":[{"Weekday":"String","WeekdayInt":0,"Open":false,"OpenHour":0,"OpenMinute":0,"CloseHour":0,"CloseMinute":0}],"MembershipData":{"Levels":[{"Level":0,"DaysAhead":0,"AllowBooking":false}]}}],"Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}