AIM Web Services

<back to all web services

GetCustomerTokensRequest

GetCustomerTokens
Requires active-e Customer Service.

The following routes are available for this service:
POST, GET/api/GetCustomerTokens
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(Name="CCInfo")
class CcInfo implements IConvertible
{
    /**
    * Token returned from processor
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="Token returned from processor", IsRequired=true, Name="TokenStr", ParameterType="query")
    String? TokenStr;

    /**
    * Card Type (VISA, MCARD, AMEX, DSCVR)
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="Card Type (VISA, MCARD, AMEX, DSCVR)", IsRequired=true, Name="CardType", ParameterType="query")
    String? CardType;

    /**
    * Last four of the card
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="Last four of the card", IsRequired=true, Name="LastFour", ParameterType="query")
    String? LastFour;

    /**
    * Expiration Date of the Card. (MM/YY)
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="Expiration Date of the Card. (MM/YY)", Name="Expiration", ParameterType="query")
    String? Expiration;

    /**
    * Reason the card is on file.
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="Reason the card is on file.", Name="ReasonOnFile", ParameterType="query")
    String? ReasonOnFile;

    /**
    * ID of the existing Token Record in AIM, if applicable
    */
    // @DataMember
    // @ApiMember(DataType="integer", Description="ID of the existing Token Record in AIM, if applicable", Format="int64", Name="TokenPk", ParameterType="query")
    int? TokenPk;

    /**
    * Is this the customer's primary card? Defaults to false.
    */
    // @DataMember
    // @ApiMember(DataType="boolean", Description="Is this the customer's primary card? Defaults to false.", Name="Primary", ParameterType="query")
    bool? Primary;

    CcInfo({this.TokenStr,this.CardType,this.LastFour,this.Expiration,this.ReasonOnFile,this.TokenPk,this.Primary});
    CcInfo.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        TokenStr = json['TokenStr'];
        CardType = json['CardType'];
        LastFour = json['LastFour'];
        Expiration = json['Expiration'];
        ReasonOnFile = json['ReasonOnFile'];
        TokenPk = json['TokenPk'];
        Primary = json['Primary'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'TokenStr': TokenStr,
        'CardType': CardType,
        'LastFour': LastFour,
        'Expiration': Expiration,
        'ReasonOnFile': ReasonOnFile,
        'TokenPk': TokenPk,
        'Primary': Primary
    };

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

// @DataContract
class AchDetail implements IConvertible
{
    // @DataMember
    String? Name;

    // @DataMember
    String? BankNumber;

    // @DataMember
    String? Routing;

    // @DataMember
    String? Type;

    AchDetail({this.Name,this.BankNumber,this.Routing,this.Type});
    AchDetail.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Name = json['Name'];
        BankNumber = json['BankNumber'];
        Routing = json['Routing'];
        Type = json['Type'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Name': Name,
        'BankNumber': BankNumber,
        'Routing': Routing,
        'Type': Type
    };

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

// @DataContract
class GetCustomerTokensResponse extends BaseResponse implements IConvertible
{
    // @DataMember
    List<CcInfo>? CustomerTokens;

    // @DataMember
    AchDetail? Ach;

    GetCustomerTokensResponse({this.CustomerTokens,this.Ach});
    GetCustomerTokensResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

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

    Map<String, dynamic> toJson() => super.toJson()..addAll({
        'CustomerTokens': JsonConverters.toJson(CustomerTokens,'List<CcInfo>',context!),
        'Ach': JsonConverters.toJson(Ach,'AchDetail',context!)
    });

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

/**
* GetCustomerTokensRequires active-e Customer Service.
*/
// @DataContract
class GetCustomerTokensRequest extends BaseSecureRequest implements IConvertible
{
    // @DataMember
    bool? GetExpiredCards;

    // @DataMember
    bool? GetInactiveCards;

    // @DataMember
    int? Acct;

    GetCustomerTokensRequest({this.GetExpiredCards,this.GetInactiveCards,this.Acct});
    GetCustomerTokensRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }

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

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

    getTypeName() => "GetCustomerTokensRequest";
    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()),
    'CcInfo': TypeInfo(TypeOf.Class, create:() => CcInfo()),
    'AchDetail': TypeInfo(TypeOf.Class, create:() => AchDetail()),
    'GetCustomerTokensResponse': TypeInfo(TypeOf.Class, create:() => GetCustomerTokensResponse()),
    'List<CcInfo>': TypeInfo(TypeOf.Class, create:() => <CcInfo>[]),
    'GetCustomerTokensRequest': TypeInfo(TypeOf.Class, create:() => GetCustomerTokensRequest()),
});

Dart GetCustomerTokensRequest 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/GetCustomerTokens HTTP/1.1 
Host: active-ewebservice.biz 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"GetExpiredCards":false,"GetInactiveCards":false,"Acct":0,"Token":"String","DeviceId":"String","AppId":"String","ApiKey":"String","OAuthToken":"String"}

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

{"CustomerTokens":[{"TokenStr":"String","CardType":"String","LastFour":"String","Expiration":"String","ReasonOnFile":"String","TokenPk":0,"Primary":false}],"Ach":{"Name":"String","BankNumber":"String","Routing":"String","Type":"String"},"Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}