AIM Web Services

<back to all web services

C2BAccessoryListingRequest

C2BAccessoryListing
Requires active-e Contracts Service.

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 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;
}

/**
* C2BAccessoryListingRequires active-e Contracts Service.
*/
// @DataContract
class C2BAccessoryListingRequest extends BaseSecureRequest implements IConvertible
{
    /**
    * Defaults to True
    */
    // @DataMember
    // @ApiMember(Description="Defaults to True", Name="IncludeAccessories", ParameterType="query")
    bool? IncludeAccessories;

    /**
    * Defaults to False
    */
    // @DataMember
    // @ApiMember(Description="Defaults to False", Name="IncludeDeliveryOptions", ParameterType="query")
    bool? IncludeDeliveryOptions;

    /**
    * Defaults to False
    */
    // @DataMember
    // @ApiMember(Description="Defaults to False", Name="IncludeMaintenanceOptions", ParameterType="query")
    bool? IncludeMaintenanceOptions;

    /**
    * If passed, only accessories for the given instrument are returned
    */
    // @DataMember
    // @ApiMember(Description="If passed, only accessories for the given instrument are returned", Name="InstrumentId", ParameterType="query")
    int? InstrumentId;

    C2BAccessoryListingRequest({this.IncludeAccessories,this.IncludeDeliveryOptions,this.IncludeMaintenanceOptions,this.InstrumentId});
    C2BAccessoryListingRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }

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

    Map<String, dynamic> toJson() => super.toJson()..addAll({
        'IncludeAccessories': IncludeAccessories,
        'IncludeDeliveryOptions': IncludeDeliveryOptions,
        'IncludeMaintenanceOptions': IncludeMaintenanceOptions,
        'InstrumentId': InstrumentId
    });

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

Dart C2BAccessoryListingRequest DTOs

GET /api/C2BAccessoryListing HTTP/1.1 
Host: active-ewebservice.biz 
Accept: text/jsonl

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