Billhighway Cloud API

<back to all web services

FormBuilderPlanTypeRq

The following routes are available for this service:
GET/signup/api/forms/templates/nat/{nationalID}/formBuilderPlanTypeID/{formBuilderPlanTypeID}/formBuilderPlanType
GET/signup/api/forms/templates/nat/{nationalID}/chap/{chapID}/formBuilderPlanTypeID/{formBuilderPlanTypeID}/formBuilderPlanType
FormBuilderPlanTypeRq Parameters:
NameParameterData TypeRequiredDescription
NationalIDpathintNo
ChapIDpathint?No
FormBuilderPlanTypeIDpathint?No
FormBuilderPlanTypeRs Parameters:
NameParameterData TypeRequiredDescription
FormBuilderPlanTypesformList<FormBuilderPlanType>No
FormBuilderPlanType Parameters:
NameParameterData TypeRequiredDescription
NationalIDformintNo
ChapIDformint?No
FormBuilderPlanTypeIDformint?No
ThemeIDformintNo
RelativeGroupInfoServiceApiformstringNo
RelativeGroupInfoServiceWithUserApiformstringNo

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}/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
		}
	]
}