Billhighway Cloud API

<back to all web services

FormTemplateClientMapRq

The following routes are available for this service:
GET/signup/api/forms/templates/nat/{nationalID}/clientmap
import 'package:servicestack/servicestack.dart';

class IntegratedPartner implements IConvertible
{
    int? IntegrationPartnerId;
    String? Name;
    String? Description;
    String? Uri;
    String? Username;
    String? Password;
    String? ApiKey;
    String? Scope;

    IntegratedPartner({this.IntegrationPartnerId,this.Name,this.Description,this.Uri,this.Username,this.Password,this.ApiKey,this.Scope});
    IntegratedPartner.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        IntegrationPartnerId = json['IntegrationPartnerId'];
        Name = json['Name'];
        Description = json['Description'];
        Uri = json['Uri'];
        Username = json['Username'];
        Password = json['Password'];
        ApiKey = json['ApiKey'];
        Scope = json['Scope'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'IntegrationPartnerId': IntegrationPartnerId,
        'Name': Name,
        'Description': Description,
        'Uri': Uri,
        'Username': Username,
        'Password': Password,
        'ApiKey': ApiKey,
        'Scope': Scope
    };

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

class FormTemplateClientMap implements IConvertible
{
    int? NationalID;
    int? ChapID;
    int? FormTemplateID;
    bool? FormBuilder;
    String? RelativeGroupInfoServiceApi;
    String? RelativeGroupInfoServiceWithUserApi;
    IntegratedPartner? MemberInfoIntegrationPartnerApi;
    bool? RequirePreAuthenticatedMember;

    FormTemplateClientMap({this.NationalID,this.ChapID,this.FormTemplateID,this.FormBuilder,this.RelativeGroupInfoServiceApi,this.RelativeGroupInfoServiceWithUserApi,this.MemberInfoIntegrationPartnerApi,this.RequirePreAuthenticatedMember});
    FormTemplateClientMap.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        NationalID = json['NationalID'];
        ChapID = json['ChapID'];
        FormTemplateID = json['FormTemplateID'];
        FormBuilder = json['FormBuilder'];
        RelativeGroupInfoServiceApi = json['RelativeGroupInfoServiceApi'];
        RelativeGroupInfoServiceWithUserApi = json['RelativeGroupInfoServiceWithUserApi'];
        MemberInfoIntegrationPartnerApi = JsonConverters.fromJson(json['MemberInfoIntegrationPartnerApi'],'IntegratedPartner',context!);
        RequirePreAuthenticatedMember = json['RequirePreAuthenticatedMember'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'NationalID': NationalID,
        'ChapID': ChapID,
        'FormTemplateID': FormTemplateID,
        'FormBuilder': FormBuilder,
        'RelativeGroupInfoServiceApi': RelativeGroupInfoServiceApi,
        'RelativeGroupInfoServiceWithUserApi': RelativeGroupInfoServiceWithUserApi,
        'MemberInfoIntegrationPartnerApi': JsonConverters.toJson(MemberInfoIntegrationPartnerApi,'IntegratedPartner',context!),
        'RequirePreAuthenticatedMember': RequirePreAuthenticatedMember
    };

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

class FormTemplateClientMapRs implements IApiResponse, IConvertible
{
    List<FormTemplateClientMap>? TemplateMaps;

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

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

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

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

class FormTemplateClientMapRq implements IApiRequest, IConvertible
{
    int? NationalID;

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

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

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

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

TypeContext _ctx = TypeContext(library: 'devapi.billhighway.com', types: <String, TypeInfo> {
    'IntegratedPartner': TypeInfo(TypeOf.Class, create:() => IntegratedPartner()),
    'FormTemplateClientMap': TypeInfo(TypeOf.Class, create:() => FormTemplateClientMap()),
    'FormTemplateClientMapRs': TypeInfo(TypeOf.Class, create:() => FormTemplateClientMapRs()),
    'List<FormTemplateClientMap>': TypeInfo(TypeOf.Class, create:() => <FormTemplateClientMap>[]),
    'FormTemplateClientMapRq': TypeInfo(TypeOf.Class, create:() => FormTemplateClientMapRq()),
});

Dart FormTemplateClientMapRq DTOs

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

HTTP + XML

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

GET /signup/api/forms/templates/nat/{nationalID}/clientmap HTTP/1.1 
Host: devapi.billhighway.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<FormTemplateClientMapRs xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BH.Client.Configuration.Service">
  <TemplateMaps xmlns:d2p1="http://schemas.datacontract.org/2004/07/BH.Client.Configuration">
    <d2p1:FormTemplateClientMap>
      <d2p1:_x003C_ChapID_x003E_k__BackingField>0</d2p1:_x003C_ChapID_x003E_k__BackingField>
      <d2p1:_x003C_FormBuilder_x003E_k__BackingField>false</d2p1:_x003C_FormBuilder_x003E_k__BackingField>
      <d2p1:_x003C_FormTemplateID_x003E_k__BackingField>0</d2p1:_x003C_FormTemplateID_x003E_k__BackingField>
      <d2p1:_x003C_MemberInfoIntegrationPartnerApi_x003E_k__BackingField>
        <d2p1:_x003C_ApiKey_x003E_k__BackingField>String</d2p1:_x003C_ApiKey_x003E_k__BackingField>
        <d2p1:_x003C_Description_x003E_k__BackingField>String</d2p1:_x003C_Description_x003E_k__BackingField>
        <d2p1:_x003C_IntegrationPartnerId_x003E_k__BackingField>0</d2p1:_x003C_IntegrationPartnerId_x003E_k__BackingField>
        <d2p1:_x003C_Name_x003E_k__BackingField>String</d2p1:_x003C_Name_x003E_k__BackingField>
        <d2p1:_x003C_Password_x003E_k__BackingField>String</d2p1:_x003C_Password_x003E_k__BackingField>
        <d2p1:_x003C_Scope_x003E_k__BackingField>String</d2p1:_x003C_Scope_x003E_k__BackingField>
        <d2p1:_x003C_Uri_x003E_k__BackingField>String</d2p1:_x003C_Uri_x003E_k__BackingField>
        <d2p1:_x003C_Username_x003E_k__BackingField>String</d2p1:_x003C_Username_x003E_k__BackingField>
      </d2p1:_x003C_MemberInfoIntegrationPartnerApi_x003E_k__BackingField>
      <d2p1:_x003C_NationalID_x003E_k__BackingField>0</d2p1:_x003C_NationalID_x003E_k__BackingField>
      <d2p1:_x003C_RelativeGroupInfoServiceApi_x003E_k__BackingField>String</d2p1:_x003C_RelativeGroupInfoServiceApi_x003E_k__BackingField>
      <d2p1:_x003C_RelativeGroupInfoServiceWithUserApi_x003E_k__BackingField>String</d2p1:_x003C_RelativeGroupInfoServiceWithUserApi_x003E_k__BackingField>
      <d2p1:_x003C_RequirePreAuthenticatedMember_x003E_k__BackingField>false</d2p1:_x003C_RequirePreAuthenticatedMember_x003E_k__BackingField>
    </d2p1:FormTemplateClientMap>
  </TemplateMaps>
</FormTemplateClientMapRs>