Billhighway Cloud API

<back to all web services

KeyRequest

The following routes are available for this service:
POST/api/keys/generate
import 'package:servicestack/servicestack.dart';

class KeyResult implements IHaveErrorField, IConvertible
{
    Map<String,int?>? KeyNameValuePairs;
    bool? IsSuccessful;
    int? ErrorCode;
    String? Message;
    bool? IsError;

    KeyResult({this.KeyNameValuePairs,this.IsSuccessful,this.ErrorCode,this.Message,this.IsError});
    KeyResult.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        KeyNameValuePairs = JsonConverters.fromJson(json['KeyNameValuePairs'],'Map<String,int?>',context!);
        IsSuccessful = json['IsSuccessful'];
        ErrorCode = json['ErrorCode'];
        Message = json['Message'];
        IsError = json['IsError'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'KeyNameValuePairs': JsonConverters.toJson(KeyNameValuePairs,'Map<String,int?>',context!),
        'IsSuccessful': IsSuccessful,
        'ErrorCode': ErrorCode,
        'Message': Message,
        'IsError': IsError
    };

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

class KeyRequest extends KeyRequest implements IConvertible
{
    KeyRequest();
    KeyRequest.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() => "KeyRequest";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'devapi.billhighway.com', types: <String, TypeInfo> {
    'KeyResult': TypeInfo(TypeOf.Class, create:() => KeyResult()),
    'Map<String,int?>': TypeInfo(TypeOf.Class, create:() => Map<String,int?>()),
    'KeyRequest': TypeInfo(TypeOf.Class, create:() => KeyRequest()),
});

Dart KeyRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /api/keys/generate HTTP/1.1 
Host: devapi.billhighway.com 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"Keys":[{"Name":"String","NumberRequested":0}],"DbName":"String"}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"KeyNameValuePairs":{"String":0},"IsSuccessful":false,"ErrorCode":0,"Message":"String","IsError":true}