Billhighway Cloud API

<back to all web services

FormBuilderModelRq

The following routes are available for this service:
POST/signup/api/formbuilder/model
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 FormBuilderModelNameValue:
    name: Optional[str] = None
    value: Optional[Object] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class FormBuilderModelRq:
    template_id: Optional[int] = None
    bh_user_i_d: Optional[str] = None
    user_type: Optional[str] = None
    client_doc_no: Optional[str] = None
    form_type: Optional[str] = None
    confirmation_number: Optional[int] = None
    name_values: Optional[List[FormBuilderModelNameValue]] = None
    group_plans: Optional[str] = None
    nat_id: Optional[int] = None
    chap_id: Optional[int] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class FormBuilderModelRs:
    message: Optional[str] = None
    model_state_id: Optional[int] = None

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

POST /signup/api/formbuilder/model HTTP/1.1 
Host: devapi.billhighway.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	TemplateId: 0,
	BhUserID: String,
	UserType: String,
	ClientDocNo: String,
	FormType: String,
	ConfirmationNumber: 0,
	NameValues: 
	[
		{
			Name: String,
			Value: {}
		}
	],
	GroupPlans: String,
	natId: 0,
	chapId: 0
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	message: String,
	modelStateId: 0
}