AIM Web Services

<back to all web services

GetSchedulingLocationsRequest

GetSchedulingLocations
Requires active-e Lesson Scheduling Service

The following routes are available for this service:
GET/api/GetSchedulingLocations
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 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 GetSchedulingLocationsResponse extends BaseResponse implements IConvertible
{
    // @DataMember
    List<LocationInfo>? Locations;

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

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

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

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

/**
* GetSchedulingLocationsRequires active-e Lesson Scheduling Service
*/
// @DataContract
class GetSchedulingLocationsRequest extends BaseRequest implements IConvertible
{
    /**
    * Location lookup. If sent, all other parameters will be ignored.
    */
    // @DataMember
    // @ApiMember(DataType="integer", Description="Location lookup. If sent, all other parameters will be ignored.", Format="int64", Name="LocationId", ParameterType="query")
    int? LocationId;

    /**
    * If sent, only locations that offer this lesson type will be returned.
    */
    // @DataMember
    // @ApiMember(DataType="integer", Description="If sent, only locations that offer this lesson type will be returned.", Format="int64", Name="TypeId", ParameterType="query")
    int? TypeId;

    /**
    * If sent, only locations that offer lessons of this grouping will be returned.
    */
    // @DataMember
    // @ApiMember(DataType="integer", Description="If sent, only locations that offer lessons of this grouping will be returned.", Format="int64", Name="GroupingId", ParameterType="query")
    int? GroupingId;

    /**
    * If sent, only locations where the sent instructor teaches will be returned.
    */
    // @DataMember
    // @ApiMember(DataType="integer", Description="If sent, only locations where the sent instructor teaches will be returned.", Format="int32", Name="InstructorId", ParameterType="query")
    int? InstructorId;

    // @DataMember
    bool? IncludeInactiveLocations;

    GetSchedulingLocationsRequest({this.LocationId,this.TypeId,this.GroupingId,this.InstructorId,this.IncludeInactiveLocations});
    GetSchedulingLocationsRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }

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

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

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

TypeContext _ctx = TypeContext(library: 'active_ewebservice.biz', types: <String, TypeInfo> {
    'BaseRequest': TypeInfo(TypeOf.Class, create:() => BaseRequest()),
    'BaseResponseResult': TypeInfo(TypeOf.Class, create:() => BaseResponseResult()),
    'BaseResponse': TypeInfo(TypeOf.Class, create:() => BaseResponse()),
    'LocationInfo': TypeInfo(TypeOf.Class, create:() => LocationInfo()),
    'GetSchedulingLocationsResponse': TypeInfo(TypeOf.Class, create:() => GetSchedulingLocationsResponse()),
    'List<LocationInfo>': TypeInfo(TypeOf.Class, create:() => <LocationInfo>[]),
    'GetSchedulingLocationsRequest': TypeInfo(TypeOf.Class, create:() => GetSchedulingLocationsRequest()),
});

Dart GetSchedulingLocationsRequest DTOs

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

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /api/GetSchedulingLocations HTTP/1.1 
Host: active-ewebservice.biz 
Accept: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetSchedulingLocationsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AIM.WebService">
  <Status>
    <DomainName>String</DomainName>
    <ErrorCode>String</ErrorCode>
    <ErrorDisplayText>String</ErrorDisplayText>
    <ErrorMessage>String</ErrorMessage>
    <IpAddress>String</IpAddress>
    <Login>String</Login>
    <StatusCode>String</StatusCode>
  </Status>
  <Locations xmlns:d2p1="http://schemas.datacontract.org/2004/07/AIM">
    <d2p1:LocationInfo>
      <d2p1:Active>false</d2p1:Active>
      <d2p1:CashSaleAcct>0</d2p1:CashSaleAcct>
      <d2p1:Desc>String</d2p1:Desc>
      <d2p1:Id>0</d2p1:Id>
      <d2p1:InStorePickup>String</d2p1:InStorePickup>
      <d2p1:Latitude>0</d2p1:Latitude>
      <d2p1:Longitude>0</d2p1:Longitude>
      <d2p1:Region>String</d2p1:Region>
      <d2p1:ShortDesc>String</d2p1:ShortDesc>
    </d2p1:LocationInfo>
  </Locations>
</GetSchedulingLocationsResponse>