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
import 'package:servicestack/servicestack.dart';

// @DataContract
class BaseRequest implements IConvertible
{
    /**
    * 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")
    String? ApiKey;

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

    BaseRequest({this.ApiKey,this.OAuthToken});
    BaseRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        ApiKey = json['ApiKey'];
        OAuthToken = json['OAuthToken'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'ApiKey': ApiKey,
        'OAuthToken': OAuthToken
    };

    getTypeName() => "BaseRequest";
    TypeContext? context = _ctx;
}

// @DataContract
class BaseSecureRequest extends BaseRequest implements IConvertible
{
    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="Token", ParameterType="Header")
    String? Token;

    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="DeviceId", ParameterType="Header")
    String? DeviceId;

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

    BaseSecureRequest({this.Token,this.DeviceId,this.AppId});
    BaseSecureRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        Token = json['Token'];
        DeviceId = json['DeviceId'];
        AppId = json['AppId'];
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson()..addAll({
        'Token': Token,
        'DeviceId': DeviceId,
        'AppId': AppId
    });

    getTypeName() => "BaseSecureRequest";
    TypeContext? context = _ctx;
}

// @DataContract
class BaseResponseResult implements IConvertible
{
    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="StatusCode", ParameterType="body")
    String? StatusCode;

    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="Login", ParameterType="body")
    String? Login;

    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="ErrorCode", ParameterType="body")
    String? ErrorCode;

    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="ErrorDisplayText", ParameterType="body")
    String? ErrorDisplayText;

    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="ErrorMessage", ParameterType="body")
    String? ErrorMessage;

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

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

    BaseResponseResult({this.StatusCode,this.Login,this.ErrorCode,this.ErrorDisplayText,this.ErrorMessage,this.DomainName,this.IpAddress});
    BaseResponseResult.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        StatusCode = json['StatusCode'];
        Login = json['Login'];
        ErrorCode = json['ErrorCode'];
        ErrorDisplayText = json['ErrorDisplayText'];
        ErrorMessage = json['ErrorMessage'];
        DomainName = json['DomainName'];
        IpAddress = json['IpAddress'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'StatusCode': StatusCode,
        'Login': Login,
        'ErrorCode': ErrorCode,
        'ErrorDisplayText': ErrorDisplayText,
        'ErrorMessage': ErrorMessage,
        'DomainName': DomainName,
        'IpAddress': IpAddress
    };

    getTypeName() => "BaseResponseResult";
    TypeContext? context = _ctx;
}

// @DataContract
class BaseResponse implements IConvertible
{
    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")
    BaseResponseResult? Status;

    BaseResponse({this.Status});
    BaseResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Status = JsonConverters.fromJson(json['Status'],'BaseResponseResult',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Status': JsonConverters.toJson(Status,'BaseResponseResult',context!)
    };

    getTypeName() => "BaseResponse";
    TypeContext? context = _ctx;
}

// @DataContract
class LocationInfo implements IConvertible
{
    // @DataMember
    int? Id;

    // @DataMember
    String? Desc;

    // @DataMember
    String? ShortDesc;

    // @DataMember
    String? Region;

    // @DataMember
    double? Latitude;

    // @DataMember
    double? Longitude;

    // @DataMember
    String? InStorePickup;

    // @DataMember
    bool? Active;

    // @DataMember
    int? CashSaleAcct;

    LocationInfo({this.Id,this.Desc,this.ShortDesc,this.Region,this.Latitude,this.Longitude,this.InStorePickup,this.Active,this.CashSaleAcct});
    LocationInfo.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Id = json['Id'];
        Desc = json['Desc'];
        ShortDesc = json['ShortDesc'];
        Region = json['Region'];
        Latitude = JsonConverters.toDouble(json['Latitude']);
        Longitude = JsonConverters.toDouble(json['Longitude']);
        InStorePickup = json['InStorePickup'];
        Active = json['Active'];
        CashSaleAcct = json['CashSaleAcct'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Id': Id,
        'Desc': Desc,
        'ShortDesc': ShortDesc,
        'Region': Region,
        'Latitude': Latitude,
        'Longitude': Longitude,
        'InStorePickup': InStorePickup,
        'Active': Active,
        'CashSaleAcct': CashSaleAcct
    };

    getTypeName() => "LocationInfo";
    TypeContext? context = _ctx;
}

// @DataContract
class WeekdayInfo implements IConvertible
{
    // @DataMember
    String? Weekday;

    // @DataMember
    int? WeekdayInt;

    // @DataMember
    bool? Open;

    // @DataMember
    int? OpenHour;

    // @DataMember
    int? OpenMinute;

    // @DataMember
    int? CloseHour;

    // @DataMember
    int? CloseMinute;

    WeekdayInfo({this.Weekday,this.WeekdayInt,this.Open,this.OpenHour,this.OpenMinute,this.CloseHour,this.CloseMinute});
    WeekdayInfo.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Weekday = json['Weekday'];
        WeekdayInt = json['WeekdayInt'];
        Open = json['Open'];
        OpenHour = json['OpenHour'];
        OpenMinute = json['OpenMinute'];
        CloseHour = json['CloseHour'];
        CloseMinute = json['CloseMinute'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Weekday': Weekday,
        'WeekdayInt': WeekdayInt,
        'Open': Open,
        'OpenHour': OpenHour,
        'OpenMinute': OpenMinute,
        'CloseHour': CloseHour,
        'CloseMinute': CloseMinute
    };

    getTypeName() => "WeekdayInfo";
    TypeContext? context = _ctx;
}

// @DataContract
class StationGroupMembershipLevel implements IConvertible
{
    // @DataMember
    int? Level;

    // @DataMember
    int? DaysAhead;

    // @DataMember
    bool? AllowBooking;

    StationGroupMembershipLevel({this.Level,this.DaysAhead,this.AllowBooking});
    StationGroupMembershipLevel.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Level = json['Level'];
        DaysAhead = json['DaysAhead'];
        AllowBooking = json['AllowBooking'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Level': Level,
        'DaysAhead': DaysAhead,
        'AllowBooking': AllowBooking
    };

    getTypeName() => "StationGroupMembershipLevel";
    TypeContext? context = _ctx;
}

// @DataContract
class StationGroupMembershipData implements IConvertible
{
    // @DataMember
    List<StationGroupMembershipLevel>? Levels;

    StationGroupMembershipData({this.Levels});
    StationGroupMembershipData.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Levels = JsonConverters.fromJson(json['Levels'],'List<StationGroupMembershipLevel>',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Levels': JsonConverters.toJson(Levels,'List<StationGroupMembershipLevel>',context!)
    };

    getTypeName() => "StationGroupMembershipData";
    TypeContext? context = _ctx;
}

// @DataContract
class StationGroupInfo implements IConvertible
{
    // @DataMember
    int? Id;

    // @DataMember
    String? Description;

    // @DataMember
    String? WebDescription;

    // @DataMember
    String? Topic;

    // @DataMember
    int? Interval;

    // @DataMember
    int? Buffer;

    // @DataMember
    LocationInfo? Location;

    // @DataMember
    int? Yards;

    // @DataMember
    List<WeekdayInfo>? Weekdays;

    // @DataMember
    StationGroupMembershipData? MembershipData;

    StationGroupInfo({this.Id,this.Description,this.WebDescription,this.Topic,this.Interval,this.Buffer,this.Location,this.Yards,this.Weekdays,this.MembershipData});
    StationGroupInfo.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Id = json['Id'];
        Description = json['Description'];
        WebDescription = json['WebDescription'];
        Topic = json['Topic'];
        Interval = json['Interval'];
        Buffer = json['Buffer'];
        Location = JsonConverters.fromJson(json['Location'],'LocationInfo',context!);
        Yards = json['Yards'];
        Weekdays = JsonConverters.fromJson(json['Weekdays'],'List<WeekdayInfo>',context!);
        MembershipData = JsonConverters.fromJson(json['MembershipData'],'StationGroupMembershipData',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Id': Id,
        'Description': Description,
        'WebDescription': WebDescription,
        'Topic': Topic,
        'Interval': Interval,
        'Buffer': Buffer,
        'Location': JsonConverters.toJson(Location,'LocationInfo',context!),
        'Yards': Yards,
        'Weekdays': JsonConverters.toJson(Weekdays,'List<WeekdayInfo>',context!),
        'MembershipData': JsonConverters.toJson(MembershipData,'StationGroupMembershipData',context!)
    };

    getTypeName() => "StationGroupInfo";
    TypeContext? context = _ctx;
}

// @DataContract
class GetStationGroupsResponse extends BaseResponse implements IConvertible
{
    // @DataMember
    List<StationGroupInfo>? StationGroups;

    GetStationGroupsResponse({this.StationGroups});
    GetStationGroupsResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        StationGroups = JsonConverters.fromJson(json['StationGroups'],'List<StationGroupInfo>',context!);
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson()..addAll({
        'StationGroups': JsonConverters.toJson(StationGroups,'List<StationGroupInfo>',context!)
    });

    getTypeName() => "GetStationGroupsResponse";
    TypeContext? context = _ctx;
}

/**
* GetStationGroupsRequires active-e Station Reservations Service
*/
// @DataContract
class GetStationGroupsRequest extends BaseSecureRequest implements IConvertible
{
    /**
    * 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")
    int? LocationId;

    GetStationGroupsRequest({this.LocationId});
    GetStationGroupsRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        LocationId = json['LocationId'];
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson()..addAll({
        'LocationId': LocationId
    });

    getTypeName() => "GetStationGroupsRequest";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'active_ewebservice.biz', types: <String, TypeInfo> {
    'BaseRequest': TypeInfo(TypeOf.Class, create:() => BaseRequest()),
    'BaseSecureRequest': TypeInfo(TypeOf.Class, create:() => BaseSecureRequest()),
    'BaseResponseResult': TypeInfo(TypeOf.Class, create:() => BaseResponseResult()),
    'BaseResponse': TypeInfo(TypeOf.Class, create:() => BaseResponse()),
    'LocationInfo': TypeInfo(TypeOf.Class, create:() => LocationInfo()),
    'WeekdayInfo': TypeInfo(TypeOf.Class, create:() => WeekdayInfo()),
    'StationGroupMembershipLevel': TypeInfo(TypeOf.Class, create:() => StationGroupMembershipLevel()),
    'StationGroupMembershipData': TypeInfo(TypeOf.Class, create:() => StationGroupMembershipData()),
    'List<StationGroupMembershipLevel>': TypeInfo(TypeOf.Class, create:() => <StationGroupMembershipLevel>[]),
    'StationGroupInfo': TypeInfo(TypeOf.Class, create:() => StationGroupInfo()),
    'List<WeekdayInfo>': TypeInfo(TypeOf.Class, create:() => <WeekdayInfo>[]),
    'GetStationGroupsResponse': TypeInfo(TypeOf.Class, create:() => GetStationGroupsResponse()),
    'List<StationGroupInfo>': TypeInfo(TypeOf.Class, create:() => <StationGroupInfo>[]),
    'GetStationGroupsRequest': TypeInfo(TypeOf.Class, create:() => GetStationGroupsRequest()),
});

Dart 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"}}