AIM Web Services

<back to all web services

C2BGetDistrictInfoRequest

C2BGetDistrictInfo
Requires active-e Contracts Service.

The following routes are available for this service:
POST, GET/api/C2BGetDistrictInfo
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 C2BDistrictGeneric implements IConvertible
{
    // @DataMember
    String? DistrictName;

    // @DataMember
    int? SchoolCount;

    // @DataMember
    int? TeacherCount;

    // @DataMember
    String? Topic;

    // @DataMember
    int? Id;

    C2BDistrictGeneric({this.DistrictName,this.SchoolCount,this.TeacherCount,this.Topic,this.Id});
    C2BDistrictGeneric.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        DistrictName = json['DistrictName'];
        SchoolCount = json['SchoolCount'];
        TeacherCount = json['TeacherCount'];
        Topic = json['Topic'];
        Id = json['Id'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'DistrictName': DistrictName,
        'SchoolCount': SchoolCount,
        'TeacherCount': TeacherCount,
        'Topic': Topic,
        'Id': Id
    };

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

// @DataContract
class C2BGetDistrictInfoResponse extends BaseResponse implements IConvertible
{
    // @DataMember
    List<C2BDistrictGeneric>? Districts;

    // @DataMember
    bool? TeacherTableExists;

    C2BGetDistrictInfoResponse({this.Districts,this.TeacherTableExists});
    C2BGetDistrictInfoResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

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

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

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

/**
* C2BGetDistrictInfoRequires active-e Contracts Service.
*/
// @DataContract
class C2BGetDistrictInfoRequest extends BaseRequest implements IConvertible
{
    /**
    * If sent, only districts with schools of the sent plan code will be returned.
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="If sent, only districts with schools of the sent plan code will be returned.", Format="date", Name="PlanCode", ParameterType="query")
    String? PlanCode;

    /**
    * ID of the Instrument record. Optional.
    */
    // @DataMember
    // @ApiMember(DataType="integer", Description="ID of the Instrument record. Optional.", Format="int64", Name="RinPk", ParameterType="query")
    int? RinPk;

    /**
    * Optional Request Type. Valid values are Contract and Shipping.
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="Optional Request Type. Valid values are Contract and Shipping.", Name="RequestType", ParameterType="query")
    String? RequestType;

    C2BGetDistrictInfoRequest({this.PlanCode,this.RinPk,this.RequestType});
    C2BGetDistrictInfoRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }

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

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

    getTypeName() => "C2BGetDistrictInfoRequest";
    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()),
    'C2BDistrictGeneric': TypeInfo(TypeOf.Class, create:() => C2BDistrictGeneric()),
    'C2BGetDistrictInfoResponse': TypeInfo(TypeOf.Class, create:() => C2BGetDistrictInfoResponse()),
    'List<C2BDistrictGeneric>': TypeInfo(TypeOf.Class, create:() => <C2BDistrictGeneric>[]),
    'C2BGetDistrictInfoRequest': TypeInfo(TypeOf.Class, create:() => C2BGetDistrictInfoRequest()),
});

Dart C2BGetDistrictInfoRequest 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.

POST /api/C2BGetDistrictInfo HTTP/1.1 
Host: active-ewebservice.biz 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"PlanCode":"String","RinPk":0,"RequestType":"String","ApiKey":"String","OAuthToken":"String"}

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

{"Districts":[{}],"TeacherTableExists":false,"Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}