Billhighway Cloud API

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 .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/forms/templates/nat/{nationalID}/clientmap HTTP/1.1 
Host: devapi.billhighway.com 
Accept: text/jsv

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	TemplateMaps: 
	[
		{
			NationalID: 0,
			ChapID: 0,
			FormTemplateID: 0,
			FormBuilder: False,
			RelativeGroupInfoServiceApi: String,
			RelativeGroupInfoServiceWithUserApi: String,
			MemberInfoIntegrationPartnerApi: 
			{
				IntegrationPartnerId: 0,
				Name: String,
				Description: String,
				Uri: String,
				Username: String,
				Password: String,
				ApiKey: String,
				Scope: String
			},
			RequirePreAuthenticatedMember: False
		}
	]
}