Billhighway Cloud API

<back to all web services

FormBuilderModelRq

The following routes are available for this service:
POST/signup/api/formbuilder/model
FormBuilderModelRq Parameters:
NameParameterData TypeRequiredDescription
TemplateIdbodyintNo
BhUserIDbodystringNo
UserTypebodystringNo
ClientDocNobodystringNo
FormTypebodystringNo
ConfirmationNumberbodyintNo
NameValuesbodyList<FormBuilderModelNameValue>No
GroupPlansbodystringNo
makeFormSubmitRequestbodyboolNo
natIdbodyintNo
chapIdbodyintNo
FormBuilderModelNameValue Parameters:
NameParameterData TypeRequiredDescription
NameformstringNo
ValueformObjectNo
FormBuilderModelRs Parameters:
NameParameterData TypeRequiredDescription
messageformstringNo
modelStateIdformintNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

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/csv
Content-Type: text/csv
Content-Length: length

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

{"message":"String","modelStateId":0}