AIM Web Services

<back to all web services

GetSchoolListRequest

GetSchoolList
Requires active-e Customer Service.

The following routes are available for this service:
GET/api/GetSchoolList
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 C2BDeliveryInfo implements IConvertible
{
    // @DataMember
    DateTime? FirstDelivery;

    // @DataMember
    DateTime? DeliveryTime;

    // @DataMember
    int? DeliveryThreshold;

    // @DataMember
    bool? SundayDelivery;

    // @DataMember
    bool? MondayDelivery;

    // @DataMember
    bool? TuesdayDelivery;

    // @DataMember
    bool? WednesdayDelivery;

    // @DataMember
    bool? ThursdayDelivery;

    // @DataMember
    bool? FridayDelivery;

    // @DataMember
    bool? SaturdayDelivery;

    C2BDeliveryInfo({this.FirstDelivery,this.DeliveryTime,this.DeliveryThreshold,this.SundayDelivery,this.MondayDelivery,this.TuesdayDelivery,this.WednesdayDelivery,this.ThursdayDelivery,this.FridayDelivery,this.SaturdayDelivery});
    C2BDeliveryInfo.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        FirstDelivery = JsonConverters.fromJson(json['FirstDelivery'],'DateTime',context!);
        DeliveryTime = JsonConverters.fromJson(json['DeliveryTime'],'DateTime',context!);
        DeliveryThreshold = json['DeliveryThreshold'];
        SundayDelivery = json['SundayDelivery'];
        MondayDelivery = json['MondayDelivery'];
        TuesdayDelivery = json['TuesdayDelivery'];
        WednesdayDelivery = json['WednesdayDelivery'];
        ThursdayDelivery = json['ThursdayDelivery'];
        FridayDelivery = json['FridayDelivery'];
        SaturdayDelivery = json['SaturdayDelivery'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'FirstDelivery': JsonConverters.toJson(FirstDelivery,'DateTime',context!),
        'DeliveryTime': JsonConverters.toJson(DeliveryTime,'DateTime',context!),
        'DeliveryThreshold': DeliveryThreshold,
        'SundayDelivery': SundayDelivery,
        'MondayDelivery': MondayDelivery,
        'TuesdayDelivery': TuesdayDelivery,
        'WednesdayDelivery': WednesdayDelivery,
        'ThursdayDelivery': ThursdayDelivery,
        'FridayDelivery': FridayDelivery,
        'SaturdayDelivery': SaturdayDelivery
    };

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

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

    // @DataMember
    String? SchoolName;

    // @DataMember
    String? District;

    // @DataMember
    String? Address;

    // @DataMember
    String? City;

    // @DataMember
    String? State;

    // @DataMember
    String? Zip;

    // @DataMember
    String? Phone;

    // @DataMember
    String? TaxAuth;

    // @DataMember
    C2BDeliveryInfo? DeliveryInfo;

    SchoolGeneric({this.Id,this.SchoolName,this.District,this.Address,this.City,this.State,this.Zip,this.Phone,this.TaxAuth,this.DeliveryInfo});
    SchoolGeneric.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Id = json['Id'];
        SchoolName = json['SchoolName'];
        District = json['District'];
        Address = json['Address'];
        City = json['City'];
        State = json['State'];
        Zip = json['Zip'];
        Phone = json['Phone'];
        TaxAuth = json['TaxAuth'];
        DeliveryInfo = JsonConverters.fromJson(json['DeliveryInfo'],'C2BDeliveryInfo',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Id': Id,
        'SchoolName': SchoolName,
        'District': District,
        'Address': Address,
        'City': City,
        'State': State,
        'Zip': Zip,
        'Phone': Phone,
        'TaxAuth': TaxAuth,
        'DeliveryInfo': JsonConverters.toJson(DeliveryInfo,'C2BDeliveryInfo',context!)
    };

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

// @DataContract
class GetSchoolListResponse extends BaseResponse implements IConvertible
{
    // @DataMember
    List<SchoolGeneric>? Schools;

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

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

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

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

/**
* GetSchoolListRequires active-e Customer Service.
*/
// @DataContract
class GetSchoolListRequest extends BaseSecureRequest implements IConvertible
{
    /**
    * District ID. Skip this parameter to return all schools. -1 will return all schools that don't have a district assigned.
    */
    // @DataMember
    // @ApiMember(DataType="integer", Description="District ID. Skip this parameter to return all schools. -1 will return all schools that don't have a district assigned.", Format="int64", Name="DistrictId", ParameterType="query")
    int? DistrictId;

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

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

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

    getTypeName() => "GetSchoolListRequest";
    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()),
    'C2BDeliveryInfo': TypeInfo(TypeOf.Class, create:() => C2BDeliveryInfo()),
    'SchoolGeneric': TypeInfo(TypeOf.Class, create:() => SchoolGeneric()),
    'GetSchoolListResponse': TypeInfo(TypeOf.Class, create:() => GetSchoolListResponse()),
    'List<SchoolGeneric>': TypeInfo(TypeOf.Class, create:() => <SchoolGeneric>[]),
    'GetSchoolListRequest': TypeInfo(TypeOf.Class, create:() => GetSchoolListRequest()),
});

Dart GetSchoolListRequest 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/GetSchoolList HTTP/1.1 
Host: active-ewebservice.biz 
Accept: application/json

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

{"Schools":[{"Id":0,"SchoolName":"String","District":"String","Address":"String","City":"String","State":"String","Zip":"String","Phone":"String","TaxAuth":"String","DeliveryInfo":{"DeliveryThreshold":0,"SundayDelivery":false,"MondayDelivery":false,"TuesdayDelivery":false,"WednesdayDelivery":false,"ThursdayDelivery":false,"FridayDelivery":false,"SaturdayDelivery":false}}],"Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}