Billhighway Cloud API

FormBuilderPlanTypeRq

The following routes are available for this service:
GET	/signup/api/forms/templates/nat/{nationalID}/chap/{chapID}/formBuilderPlanTypeID/{formBuilderPlanTypeID}/formBuilderPlanType

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 FormBuilderPlanType:
    national_i_d: Optional[int] = None
    chap_i_d: Optional[int] = None
    form_builder_plan_type_i_d: Optional[int] = None
    theme_i_d: Optional[int] = None
    relative_group_info_service_api: Optional[str] = None
    relative_group_info_service_with_user_api: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class FormBuilderPlanTypeRs(IApiResponse):
    form_builder_plan_types: Optional[List[FormBuilderPlanType]] = None


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

Python FormBuilderPlanTypeRq 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}/chap/{chapID}/formBuilderPlanTypeID/{formBuilderPlanTypeID}/formBuilderPlanType HTTP/1.1 
Host: devapi.billhighway.com 
Accept: text/jsv

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

{
	FormBuilderPlanTypes: 
	[
		{
			NationalID: 0,
			ChapID: 0,
			FormBuilderPlanTypeID: 0,
			ThemeID: 0,
			RelativeGroupInfoServiceApi: String,
			RelativeGroupInfoServiceWithUserApi: String
		}
	]
}