AIM Web Services

<back to all web services

C2BGetPlanInfoRequest

C2BGetPlanInfo
Requires active-e Contracts Service.

The following routes are available for this service:
POST, GET/api/C2BGetPlanInfo
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 C2BPlanGeneric implements IConvertible
{
    // @DataMember
    int? Id;

    // @DataMember
    String? Code;

    // @DataMember
    String? Name;

    // @DataMember
    int? Months;

    // @DataMember
    String? Topic;

    // @DataMember
    String? FinalTopic;

    // @DataMember
    String? Url;

    C2BPlanGeneric({this.Id,this.Code,this.Name,this.Months,this.Topic,this.FinalTopic,this.Url});
    C2BPlanGeneric.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Id = json['Id'];
        Code = json['Code'];
        Name = json['Name'];
        Months = json['Months'];
        Topic = json['Topic'];
        FinalTopic = json['FinalTopic'];
        Url = json['Url'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Id': Id,
        'Code': Code,
        'Name': Name,
        'Months': Months,
        'Topic': Topic,
        'FinalTopic': FinalTopic,
        'Url': Url
    };

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

// @DataContract
class C2BGetPlanInfoResponse extends BaseResponse implements IConvertible
{
    // @DataMember
    List<C2BPlanGeneric>? Plans;

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

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

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

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

/**
* C2BGetPlanInfoRequires active-e Contracts Service.
*/
// @DataContract
class C2BGetPlanInfoRequest extends BaseRequest implements IConvertible
{
    /**
    * If sent, only info on the plan code sent will be returned. Otherwise info on all plan codes will be returned.
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="If sent, only info on the plan code sent will be returned. Otherwise info on all plan codes will be returned.", Name="PlanCode", ParameterType="query")
    String? PlanCode;

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

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

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

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

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

POST /api/C2BGetPlanInfo HTTP/1.1 
Host: active-ewebservice.biz 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"PlanCode":"String","ApiKey":"String","OAuthToken":"String"}

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

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