Billhighway Cloud API

<back to all web services

StandardSignupFormInfoGetRq

The following routes are available for this service:
GET/signup/api/nat/{natID}/standardSignup/info
GET/signup/api/nat/{natID}/group/{groupId}/{usertype}/user/{userid}/standardSignup/info
import 'package:servicestack/servicestack.dart';

class StandardSignupFormInfoGetRq implements IApiRequest, IConvertible
{
    int? NatID;
    int? GroupId;
    String? UserId;
    String? UserType;

    StandardSignupFormInfoGetRq({this.NatID,this.GroupId,this.UserId,this.UserType});
    StandardSignupFormInfoGetRq.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        NatID = json['NatID'];
        GroupId = json['GroupId'];
        UserId = json['UserId'];
        UserType = json['UserType'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'NatID': NatID,
        'GroupId': GroupId,
        'UserId': UserId,
        'UserType': UserType
    };

    getTypeName() => "StandardSignupFormInfoGetRq";
    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 CountryDto implements IConvertible
{
    int? CountryID;
    String? FullName;
    String? Abbr;

    CountryDto({this.CountryID,this.FullName,this.Abbr});
    CountryDto.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        CountryID = json['CountryID'];
        FullName = json['FullName'];
        Abbr = json['Abbr'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'CountryID': CountryID,
        'FullName': FullName,
        'Abbr': Abbr
    };

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

class StateDto implements IConvertible
{
    int? StateID;
    int? CountryID;
    String? FullName;
    String? Abbr;

    StateDto({this.StateID,this.CountryID,this.FullName,this.Abbr});
    StateDto.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        StateID = json['StateID'];
        CountryID = json['CountryID'];
        FullName = json['FullName'];
        Abbr = json['Abbr'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'StateID': StateID,
        'CountryID': CountryID,
        'FullName': FullName,
        'Abbr': Abbr
    };

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

class ChapterDto implements IConvertible
{
    int? ChapId;
    String? College;
    String? Designation;

    ChapterDto({this.ChapId,this.College,this.Designation});
    ChapterDto.fromJson(Map<String, dynamic> json) { fromMap(json); }

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

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

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

class MemberType implements IConvertible
{
    int? MemTypeId;
    int? NationalId;
    int? ChapId;
    String? Description;
    bool? IsPrimary;

    MemberType({this.MemTypeId,this.NationalId,this.ChapId,this.Description,this.IsPrimary});
    MemberType.fromJson(Map<String, dynamic> json) { fromMap(json); }

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

    Map<String, dynamic> toJson() => {
        'MemTypeId': MemTypeId,
        'NationalId': NationalId,
        'ChapId': ChapId,
        'Description': Description,
        'IsPrimary': IsPrimary
    };

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

class StandardSignupFormInfo implements IConvertible
{
    List<ContextualHelpDto>? ContextualHelp;
    List<CountryDto>? Countries;
    List<StateDto>? States;
    List<ChapterDto>? Chapters;
    List<MemberType>? MemberTypes;

    StandardSignupFormInfo({this.ContextualHelp,this.Countries,this.States,this.Chapters,this.MemberTypes});
    StandardSignupFormInfo.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        ContextualHelp = JsonConverters.fromJson(json['ContextualHelp'],'List<ContextualHelpDto>',context!);
        Countries = JsonConverters.fromJson(json['Countries'],'List<CountryDto>',context!);
        States = JsonConverters.fromJson(json['States'],'List<StateDto>',context!);
        Chapters = JsonConverters.fromJson(json['Chapters'],'List<ChapterDto>',context!);
        MemberTypes = JsonConverters.fromJson(json['MemberTypes'],'List<MemberType>',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'ContextualHelp': JsonConverters.toJson(ContextualHelp,'List<ContextualHelpDto>',context!),
        'Countries': JsonConverters.toJson(Countries,'List<CountryDto>',context!),
        'States': JsonConverters.toJson(States,'List<StateDto>',context!),
        'Chapters': JsonConverters.toJson(Chapters,'List<ChapterDto>',context!),
        'MemberTypes': JsonConverters.toJson(MemberTypes,'List<MemberType>',context!)
    };

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

class Link implements IConvertible
{
    String? Rel;
    String? Url;

    Link({this.Rel,this.Url});
    Link.fromJson(Map<String, dynamic> json) { fromMap(json); }

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

    Map<String, dynamic> toJson() => {
        'Rel': Rel,
        'Url': Url
    };

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

class StandardSignupFormInfoGetRs implements IApiResponse, IConvertible
{
    StandardSignupFormInfo? StandardSignupFormInfo;
    List<Link>? Links;

    StandardSignupFormInfoGetRs({this.StandardSignupFormInfo,this.Links});
    StandardSignupFormInfoGetRs.fromJson(Map<String, dynamic> json) { fromMap(json); }

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

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

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

TypeContext _ctx = TypeContext(library: 'devapi.billhighway.com', types: <String, TypeInfo> {
    'StandardSignupFormInfoGetRq': TypeInfo(TypeOf.Class, create:() => StandardSignupFormInfoGetRq()),
    'ContextualHelpDto': TypeInfo(TypeOf.Class, create:() => ContextualHelpDto()),
    'CountryDto': TypeInfo(TypeOf.Class, create:() => CountryDto()),
    'StateDto': TypeInfo(TypeOf.Class, create:() => StateDto()),
    'ChapterDto': TypeInfo(TypeOf.Class, create:() => ChapterDto()),
    'MemberType': TypeInfo(TypeOf.Class, create:() => MemberType()),
    'StandardSignupFormInfo': TypeInfo(TypeOf.Class, create:() => StandardSignupFormInfo()),
    'List<ContextualHelpDto>': TypeInfo(TypeOf.Class, create:() => <ContextualHelpDto>[]),
    'List<CountryDto>': TypeInfo(TypeOf.Class, create:() => <CountryDto>[]),
    'List<StateDto>': TypeInfo(TypeOf.Class, create:() => <StateDto>[]),
    'List<ChapterDto>': TypeInfo(TypeOf.Class, create:() => <ChapterDto>[]),
    'List<MemberType>': TypeInfo(TypeOf.Class, create:() => <MemberType>[]),
    'Link': TypeInfo(TypeOf.Class, create:() => Link()),
    'StandardSignupFormInfoGetRs': TypeInfo(TypeOf.Class, create:() => StandardSignupFormInfoGetRs()),
    'List<Link>': TypeInfo(TypeOf.Class, create:() => <Link>[]),
});

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

GET /signup/api/nat/{natID}/standardSignup/info HTTP/1.1 
Host: devapi.billhighway.com 
Accept: application/json

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

{"StandardSignupFormInfo":{"ContextualHelp":[{"ControlName":"String","LabelText":"String","IsVisible":false,"IsRequired":false}],"Countries":[{"CountryID":0,"FullName":"String","Abbr":"String"}],"States":[{"StateID":0,"CountryID":0,"FullName":"String","Abbr":"String"}],"Chapters":[{"ChapId":0,"College":"String","Designation":"String"}],"MemberTypes":[{"MemTypeId":0,"NationalId":0,"ChapId":0,"Description":"String","IsPrimary":false}]},"Links":[{"Rel":"String","Url":"String"}]}