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 datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class IntegratedPartner:
    integration_partner_id: Optional[int] = None
    name: Optional[str] = None
    description: Optional[str] = None
    uri: Optional[str] = None
    username: Optional[str] = None
    password: Optional[str] = None
    api_key: Optional[str] = None
    scope: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class FormTemplateClientMap:
    national_i_d: Optional[int] = None
    chap_i_d: Optional[int] = None
    form_template_i_d: Optional[int] = None
    form_builder: Optional[bool] = None
    relative_group_info_service_api: Optional[str] = None
    relative_group_info_service_with_user_api: Optional[str] = None
    member_info_integration_partner_api: Optional[IntegratedPartner] = None
    require_pre_authenticated_member: Optional[bool] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class FormTemplateClientMapRs(IApiResponse):
    template_maps: Optional[List[FormTemplateClientMap]] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class FormTemplateClientMapRq(IApiRequest):
    national_i_d: Optional[int] = None

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