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

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<FormBuilderPlanTypeRs xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BH.Client.Configuration.Service">
  <FormBuilderPlanTypes xmlns:d2p1="http://schemas.datacontract.org/2004/07/BH.Client.Configuration">
    <d2p1:FormBuilderPlanType>
      <d2p1:_x003C_ChapID_x003E_k__BackingField>0</d2p1:_x003C_ChapID_x003E_k__BackingField>
      <d2p1:_x003C_FormBuilderPlanTypeID_x003E_k__BackingField>0</d2p1:_x003C_FormBuilderPlanTypeID_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_ThemeID_x003E_k__BackingField>0</d2p1:_x003C_ThemeID_x003E_k__BackingField>
    </d2p1:FormBuilderPlanType>
  </FormBuilderPlanTypes>
</FormBuilderPlanTypeRs>