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 java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    public static class FormTemplateClientMapRq implements IApiRequest
    {
        public Integer NationalID = null;
        
        public Integer getNationalID() { return NationalID; }
        public FormTemplateClientMapRq setNationalID(Integer value) { this.NationalID = value; return this; }
    }

    public static class FormTemplateClientMapRs implements IApiResponse
    {
        public ArrayList<FormTemplateClientMap> TemplateMaps = null;
        
        public ArrayList<FormTemplateClientMap> getTemplateMaps() { return TemplateMaps; }
        public FormTemplateClientMapRs setTemplateMaps(ArrayList<FormTemplateClientMap> value) { this.TemplateMaps = value; return this; }
    }

    public static class FormTemplateClientMap
    {
        public Integer NationalID = null;
        public Integer ChapID = null;
        public Integer FormTemplateID = null;
        public Boolean FormBuilder = null;
        public String RelativeGroupInfoServiceApi = null;
        public String RelativeGroupInfoServiceWithUserApi = null;
        public IntegratedPartner MemberInfoIntegrationPartnerApi = null;
        public Boolean RequirePreAuthenticatedMember = null;
        
        public Integer getNationalID() { return NationalID; }
        public FormTemplateClientMap setNationalID(Integer value) { this.NationalID = value; return this; }
        public Integer getChapID() { return ChapID; }
        public FormTemplateClientMap setChapID(Integer value) { this.ChapID = value; return this; }
        public Integer getFormTemplateID() { return FormTemplateID; }
        public FormTemplateClientMap setFormTemplateID(Integer value) { this.FormTemplateID = value; return this; }
        public Boolean isFormBuilder() { return FormBuilder; }
        public FormTemplateClientMap setFormBuilder(Boolean value) { this.FormBuilder = value; return this; }
        public String getRelativeGroupInfoServiceApi() { return RelativeGroupInfoServiceApi; }
        public FormTemplateClientMap setRelativeGroupInfoServiceApi(String value) { this.RelativeGroupInfoServiceApi = value; return this; }
        public String getRelativeGroupInfoServiceWithUserApi() { return RelativeGroupInfoServiceWithUserApi; }
        public FormTemplateClientMap setRelativeGroupInfoServiceWithUserApi(String value) { this.RelativeGroupInfoServiceWithUserApi = value; return this; }
        public IntegratedPartner getMemberInfoIntegrationPartnerApi() { return MemberInfoIntegrationPartnerApi; }
        public FormTemplateClientMap setMemberInfoIntegrationPartnerApi(IntegratedPartner value) { this.MemberInfoIntegrationPartnerApi = value; return this; }
        public Boolean isRequirePreAuthenticatedMember() { return RequirePreAuthenticatedMember; }
        public FormTemplateClientMap setRequirePreAuthenticatedMember(Boolean value) { this.RequirePreAuthenticatedMember = value; return this; }
    }

    public static class IntegratedPartner
    {
        public Integer IntegrationPartnerId = null;
        public String Name = null;
        public String Description = null;
        public String Uri = null;
        public String Username = null;
        public String Password = null;
        public String ApiKey = null;
        public String Scope = null;
        
        public Integer getIntegrationPartnerId() { return IntegrationPartnerId; }
        public IntegratedPartner setIntegrationPartnerId(Integer value) { this.IntegrationPartnerId = value; return this; }
        public String getName() { return Name; }
        public IntegratedPartner setName(String value) { this.Name = value; return this; }
        public String getDescription() { return Description; }
        public IntegratedPartner setDescription(String value) { this.Description = value; return this; }
        public String getUri() { return Uri; }
        public IntegratedPartner setUri(String value) { this.Uri = value; return this; }
        public String getUsername() { return Username; }
        public IntegratedPartner setUsername(String value) { this.Username = value; return this; }
        public String getPassword() { return Password; }
        public IntegratedPartner setPassword(String value) { this.Password = value; return this; }
        public String getApiKey() { return ApiKey; }
        public IntegratedPartner setApiKey(String value) { this.ApiKey = value; return this; }
        public String getScope() { return Scope; }
        public IntegratedPartner setScope(String value) { this.Scope = value; return this; }
    }

}

Java 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>