AIM Web Services

<back to all web services

GetTaxAuthoritiesRequest

GetTaxAuthorities
Requires active-e Customer Service.

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

    // @DataMember
    String? Desc;

    // @DataMember
    String? ShortDesc;

    // @DataMember
    String? City;

    // @DataMember
    String? County;

    // @DataMember
    String? ZipCode;

    // @DataMember
    String? GeoCode;

    // @DataMember
    double? TaxRate1;

    // @DataMember
    double? TaxRate2;

    TaxAuthoritityInfo({this.Id,this.Desc,this.ShortDesc,this.City,this.County,this.ZipCode,this.GeoCode,this.TaxRate1,this.TaxRate2});
    TaxAuthoritityInfo.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Id = json['Id'];
        Desc = json['Desc'];
        ShortDesc = json['ShortDesc'];
        City = json['City'];
        County = json['County'];
        ZipCode = json['ZipCode'];
        GeoCode = json['GeoCode'];
        TaxRate1 = JsonConverters.toDouble(json['TaxRate1']);
        TaxRate2 = JsonConverters.toDouble(json['TaxRate2']);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Id': Id,
        'Desc': Desc,
        'ShortDesc': ShortDesc,
        'City': City,
        'County': County,
        'ZipCode': ZipCode,
        'GeoCode': GeoCode,
        'TaxRate1': TaxRate1,
        'TaxRate2': TaxRate2
    };

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

// @DataContract
class GetTaxAuthoritiesResponse extends BaseResponse implements IConvertible
{
    // @DataMember
    List<TaxAuthoritityInfo>? TaxAuthorities;

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

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

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

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

/**
* GetTaxAuthoritiesRequires active-e Customer Service.
*/
// @DataContract
class GetTaxAuthoritiesRequest extends BaseSecureRequest implements IConvertible
{
    /**
    * Tax Authority lookup. If sent, all other parameters will be ignored.
    */
    // @DataMember
    // @ApiMember(DataType="integer", Description="Tax Authority lookup. If sent, all other parameters will be ignored.", Format="int64", Name="TaxAuthorityId", ParameterType="query")
    int? TaxAuthorityId;

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

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

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

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

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

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

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

{"TaxAuthorities":[{"Id":0,"Desc":"String","ShortDesc":"String","City":"String","County":"String","ZipCode":"String","GeoCode":"String","TaxRate1":0,"TaxRate2":0}],"Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}