Billhighway Cloud API

<back to all web services

crmRequest

import 'package:servicestack/servicestack.dart';

class ResultCode
{
    static const ResultCode Success = const ResultCode._(0);
    static const ResultCode Duplicate = const ResultCode._(-7);
    static const ResultCode NotAvailable = const ResultCode._(-6);
    static const ResultCode NotFound = const ResultCode._(-5);
    static const ResultCode GeneralError = const ResultCode._(-4);
    static const ResultCode UnexpectedError = const ResultCode._(-3);
    static const ResultCode CreditCardDeclined = const ResultCode._(-2);
    static const ResultCode DataValidationFailure = const ResultCode._(-1);

    final int _value;
    const ResultCode._(this._value);
    int get value => _value;
    static List<ResultCode> get values => const [Success,Duplicate,NotAvailable,NotFound,GeneralError,UnexpectedError,CreditCardDeclined,DataValidationFailure];
}

// @DataContract(Namespace="www.billhighway.com/api")
class LegacyApiResponse implements IHaveErrorField, IConvertible
{
    // @DataMember
    double? amount;

    // @DataMember
    String? confirmationNumber;

    // @DataMember
    String? responseCode;

    // @DataMember
    String? responseDescription;

    // @DataMember
    ResultCode? resultCode;

    LegacyApiResponse({this.amount,this.confirmationNumber,this.responseCode,this.responseDescription,this.resultCode});
    LegacyApiResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        amount = JsonConverters.toDouble(json['amount']);
        confirmationNumber = json['confirmationNumber'];
        responseCode = json['responseCode'];
        responseDescription = json['responseDescription'];
        resultCode = JsonConverters.fromJson(json['resultCode'],'ResultCode',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'amount': amount,
        'confirmationNumber': confirmationNumber,
        'responseCode': responseCode,
        'responseDescription': responseDescription,
        'resultCode': JsonConverters.toJson(resultCode,'ResultCode',context!)
    };

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

// @DataContract(Namespace="www.billhighway.com/api")
class crmRequestResponse implements IHaveErrorField, IConvertible
{
    // @DataMember
    LegacyApiResponse? crmRequestResult;

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

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

    Map<String, dynamic> toJson() => {
        'crmRequestResult': JsonConverters.toJson(crmRequestResult,'LegacyApiResponse',context!)
    };

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

class crmRequest extends crmRequest implements IConvertible
{
    crmRequest();
    crmRequest.fromJson(Map<String, dynamic> json) : super.fromJson(json);
    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson();
    getTypeName() => "crmRequest";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'devapi.billhighway.com', types: <String, TypeInfo> {
    'ResultCode': TypeInfo(TypeOf.Enum, enumValues:ResultCode.values),
    'LegacyApiResponse': TypeInfo(TypeOf.Class, create:() => LegacyApiResponse()),
    'crmRequestResponse': TypeInfo(TypeOf.Class, create:() => crmRequestResponse()),
    'crmRequest': TypeInfo(TypeOf.Class, create:() => crmRequest()),
});

Dart crmRequest 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 /json/reply/crmRequest HTTP/1.1 
Host: devapi.billhighway.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"apiKey":"String","featureID":0,"clientID":0,"groupID":0,"activityID":0,"docNo":0,"docTypeID":0,"crmInfo":"String"}

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

{"crmRequestResult":{"amount":0,"confirmationNumber":"String","responseCode":"String","responseDescription":"String","resultCode":0}}