Billhighway Cloud API

<back to all web services

StandardSignupFormChapterContextualHelpRq

The following routes are available for this service:
GET/signup/api/nat/{natID}/chap/{chapID}/standardSignup/contextualHelp
import 'package:servicestack/servicestack.dart';

class StandardSignupFormChapterContextualHelpRq implements IApiRequest, IConvertible
{
    String? NatId;
    String? ChapId;

    StandardSignupFormChapterContextualHelpRq({this.NatId,this.ChapId});
    StandardSignupFormChapterContextualHelpRq.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        NatId = json['NatId'];
        ChapId = json['ChapId'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'NatId': NatId,
        'ChapId': ChapId
    };

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

class ContextualHelpDto implements IConvertible
{
    String? ControlName;
    String? LabelText;
    bool? IsVisible;
    bool? IsRequired;

    ContextualHelpDto({this.ControlName,this.LabelText,this.IsVisible,this.IsRequired});
    ContextualHelpDto.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        ControlName = json['ControlName'];
        LabelText = json['LabelText'];
        IsVisible = json['IsVisible'];
        IsRequired = json['IsRequired'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'ControlName': ControlName,
        'LabelText': LabelText,
        'IsVisible': IsVisible,
        'IsRequired': IsRequired
    };

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

class StandardSignupFormChapterContextualHelpRs implements IApiResponse, IConvertible
{
    List<ContextualHelpDto>? ContextualHelpList;

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

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

    Map<String, dynamic> toJson() => {
        'ContextualHelpList': JsonConverters.toJson(ContextualHelpList,'List<ContextualHelpDto>',context!)
    };

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

TypeContext _ctx = TypeContext(library: 'devapi.billhighway.com', types: <String, TypeInfo> {
    'StandardSignupFormChapterContextualHelpRq': TypeInfo(TypeOf.Class, create:() => StandardSignupFormChapterContextualHelpRq()),
    'ContextualHelpDto': TypeInfo(TypeOf.Class, create:() => ContextualHelpDto()),
    'StandardSignupFormChapterContextualHelpRs': TypeInfo(TypeOf.Class, create:() => StandardSignupFormChapterContextualHelpRs()),
    'List<ContextualHelpDto>': TypeInfo(TypeOf.Class, create:() => <ContextualHelpDto>[]),
});

Dart StandardSignupFormChapterContextualHelpRq DTOs

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

HTTP + JSV

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

GET /signup/api/nat/{natID}/chap/{chapID}/standardSignup/contextualHelp HTTP/1.1 
Host: devapi.billhighway.com 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	ContextualHelpList: 
	[
		{
			ControlName: String,
			LabelText: String,
			IsVisible: False,
			IsRequired: False
		}
	]
}