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

// @DataContract
export class BaseRequest
{
    /** @description This is your AIM API Key provided by Tri-Tech */
    // @DataMember
    // @ApiMember(DataType="string", Description="This is your AIM API Key provided by Tri-Tech", IsRequired=true, Name="ApiKey", ParameterType="header")
    public ApiKey: string;

    // @DataMember
    // @ApiMember(DataType="string", Name="OAuthToken", ParameterType="header")
    public OAuthToken: string;

    public constructor(init?: Partial<BaseRequest>) { (Object as any).assign(this, init); }
}

// @DataContract
export class BaseSecureRequest extends BaseRequest
{
    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="Token", ParameterType="Header")
    public Token: string;

    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="DeviceId", ParameterType="Header")
    public DeviceId: string;

    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", IsRequired=true, Name="AppId", ParameterType="Header")
    public AppId: string;

    public constructor(init?: Partial<BaseSecureRequest>) { super(init); (Object as any).assign(this, init); }
}

// @DataContract
export class BaseResponseResult
{
    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="StatusCode", ParameterType="body")
    public StatusCode: string;

    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="Login", ParameterType="body")
    public Login: string;

    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="ErrorCode", ParameterType="body")
    public ErrorCode: string;

    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="ErrorDisplayText", ParameterType="body")
    public ErrorDisplayText: string;

    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="ErrorMessage", ParameterType="body")
    public ErrorMessage: string;

    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="DomainName", ParameterType="body")
    public DomainName: string;

    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")
    public IpAddress: string;

    public constructor(init?: Partial<BaseResponseResult>) { (Object as any).assign(this, init); }
}

// @DataContract
export class BaseResponse
{
    /** @description  */
    // @DataMember
    // @ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")
    public Status: BaseResponseResult;

    public constructor(init?: Partial<BaseResponse>) { (Object as any).assign(this, init); }
}

// @DataContract
export class LocationInfo
{
    // @DataMember
    public Id: number;

    // @DataMember
    public Desc: string;

    // @DataMember
    public ShortDesc: string;

    // @DataMember
    public Region: string;

    // @DataMember
    public Latitude: number;

    // @DataMember
    public Longitude: number;

    // @DataMember
    public InStorePickup: string;

    // @DataMember
    public Active: boolean;

    // @DataMember
    public CashSaleAcct?: number;

    public constructor(init?: Partial<LocationInfo>) { (Object as any).assign(this, init); }
}

// @DataContract
export class WeekdayInfo
{
    // @DataMember
    public Weekday: string;

    // @DataMember
    public WeekdayInt: number;

    // @DataMember
    public Open: boolean;

    // @DataMember
    public OpenHour?: number;

    // @DataMember
    public OpenMinute?: number;

    // @DataMember
    public CloseHour?: number;

    // @DataMember
    public CloseMinute?: number;

    public constructor(init?: Partial<WeekdayInfo>) { (Object as any).assign(this, init); }
}

// @DataContract
export class StationGroupMembershipLevel
{
    // @DataMember
    public Level: number;

    // @DataMember
    public DaysAhead: number;

    // @DataMember
    public AllowBooking: boolean;

    public constructor(init?: Partial<StationGroupMembershipLevel>) { (Object as any).assign(this, init); }
}

// @DataContract
export class StationGroupMembershipData
{
    // @DataMember
    public Levels: StationGroupMembershipLevel[];

    public constructor(init?: Partial<StationGroupMembershipData>) { (Object as any).assign(this, init); }
}

// @DataContract
export class StationGroupInfo
{
    // @DataMember
    public Id: number;

    // @DataMember
    public Description: string;

    // @DataMember
    public WebDescription: string;

    // @DataMember
    public Topic: string;

    // @DataMember
    public Interval: number;

    // @DataMember
    public Buffer: number;

    // @DataMember
    public Location: LocationInfo;

    // @DataMember
    public Yards: number;

    // @DataMember
    public Weekdays: WeekdayInfo[];

    // @DataMember
    public MembershipData: StationGroupMembershipData;

    public constructor(init?: Partial<StationGroupInfo>) { (Object as any).assign(this, init); }
}

// @DataContract
export class GetStationGroupsResponse extends BaseResponse
{
    // @DataMember
    public StationGroups: StationGroupInfo[];

    public constructor(init?: Partial<GetStationGroupsResponse>) { super(init); (Object as any).assign(this, init); }
}

/** @description GetStationGroupsRequires active-e Station Reservations Service */
// @DataContract
export class GetStationGroupsRequest extends BaseSecureRequest
{
    /** @description If sent, only station groups at the passed location will be returned. */
    // @DataMember
    // @ApiMember(DataType="integer", Description="If sent, only station groups at the passed location will be returned.", Format="int64", Name="LocationId", ParameterType="query")
    public LocationId?: number;

    public constructor(init?: Partial<GetStationGroupsRequest>) { super(init); (Object as any).assign(this, init); }
}

TypeScript GetStationGroupsRequest 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/GetStationGroups HTTP/1.1 
Host: active-ewebservice.biz 
Accept: application/json

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