Billhighway Cloud API

FormBuilderRq

The following routes are available for this service:
GET	/signup/api/nat/{natID}/group/{groupId}/formBuilder/type/{FormBuilderTypeID}/info
GET	/signup/api/nat/{natID}/group/{groupId}/{usertype}/user/{userid}/formBuilder/type/{FormBuilderTypeID}/info

**FormBuilderRq** Parameters:
Name	Parameter	Data Type	Required
NatID	path	int	No
GroupId	path	int?	No
FormBuilderTypeID	path	int?	No
UserType	path	string	No
UserId	path	string	No

**FormBuilderRs** Parameters:
Name	Parameter	Data Type	Required	Description
form	form	BhFormDto	No
services	form	List<BhServiceInfoDto>	No

**BhFormDto** Parameters:
Name	Parameter	Data Type	Required	Description
templateId	form	int	No
groups	form	List<BhGroupDto>	No

**BhGroupDto** Parameters:
Name	Parameter	Data Type	Required
name	form	string	No
type	form	string	No
groupStyle	form	string	No
debug	form	bool	No
notifyPubs	form	List<BhNotifyPub>	No
notifySubs	form	List<BhNotifySub>	No
controlDetails	form	List<BhControlDto>	No
childGroup	form	BhGroupDto	No

**BhNotifyPub** Parameters:
Name	Parameter	Data Type	Required
notifyType	form	string	No
notifyEventType	form	string	No
delay	form	int	No

**BhNotifySub** Parameters:
Name	Parameter	Data Type	Required	Description
notifyType	form	string	No
notifyActionType	form	string	No

**BhControlDto** Parameters:
Name	Parameter	Data Type	Required
disabled	form	bool?	No
label	form	string	No
label2	form	string	No
name	form	string	No
options	form	List<BhNameValue>	No
conditionalValues	form	List<string>	No
selectGetUri	form	string	No
validation	form	List<BhValidation>	No
notifyPubs	form	List<BhNotifyPub>	No
notifySubs	form	List<BhNotifySub>	No
customValidation	form	BhCustomValidation	No
placeholder	form	string	No
type	form	string	No
value	form	Object	No
validationMessages	form	Dictionary<string, string>	No
validationPosition	form	string	No
hideInitialValidation	form	bool	No
widthClass	form	string	No
html	form	string	No
img	form	string	No
imgWidth	form	string	No
category	form	string	No
getUri	form	string	No
controlStyle	form	string	No
hasSensitiveData	form	bool	No
debug	form	bool	No
icon	form	string	No
mask	form	string	No
postService	form	int	No
printType	form	string	No
radioNames	form	List<BhNameValue>	No
children	form	List<BhControlDto>	No

**BhNameValue** Parameters:
Name	Parameter	Data Type	Required	Description
name	form	string	No
value	form	string	No

**BhValidation** Parameters:
Name	Parameter	Data Type	Required
validationName	form	string	No
validationLength	form	decimal?	No
validationPattern	form	string	No

**BhCustomValidation** Parameters:
Name	Parameter	Data Type	Required	Description
customFunctionName	form	string	No
customParams	form	List<string>	No

**BhServiceInfoDto** Parameters:
Name	Parameter	Data Type	Required
serviceId	form	int	No
serviceName	form	string	No
uri	form	string	No
serviceType	form	string	No
initFormState	form	bool	No
serviceDetails	form	List<BhServiceDetailInfoDto>	No

**BhServiceDetailInfoDto** Parameters:
Name	Parameter	Data Type	Required
serviceId	form	int	No
name	form	string	No
mappedName	form	string	No
required	form	bool	No

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/nat/{natID}/group/{groupId}/formBuilder/type/{FormBuilderTypeID}/info HTTP/1.1 
Host: devapi.billhighway.com 
Accept: text/jsv

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

{
	form: 
	{
		templateId: 0,
		groups: 
		[
			{
				name: String,
				type: String,
				groupStyle: String,
				debug: False,
				notifyPubs: 
				[
					{
						notifyType: String,
						notifyEventType: String,
						delay: 0
					}
				],
				notifySubs: 
				[
					{
						notifyType: String,
						notifyActionType: String
					}
				],
				controlDetails: 
				[
					{
						disabled: False,
						label: String,
						label2: String,
						name: String,
						options: 
						[
							{
								name: String,
								value: String
							}
						],
						conditionalValues: 
						[
							String
						],
						selectGetUri: String,
						validation: 
						[
							{
								validationName: String,
								validationLength: 0,
								validationPattern: String
							}
						],
						notifyPubs: 
						[
							{
								notifyType: String,
								notifyEventType: String,
								delay: 0
							}
						],
						notifySubs: 
						[
							{
								notifyType: String,
								notifyActionType: String
							}
						],
						customValidation: 
						{
							customFunctionName: String,
							customParams: 
							[
								String
							]
						},
						placeholder: String,
						type: String,
						value: {},
						validationMessages: 
						{
							String: String
						},
						validationPosition: String,
						hideInitialValidation: False,
						widthClass: String,
						html: String,
						img: String,
						imgWidth: String,
						category: String,
						getUri: String,
						controlStyle: String,
						hasSensitiveData: False,
						debug: False,
						icon: String,
						mask: String,
						postService: 0,
						printType: String,
						radioNames: 
						[
							{
								name: String,
								value: String
							}
						],
						children: 
						[
							{
								disabled: False,
								label: String,
								label2: String,
								name: String,
								options: 
								[
									{
										name: String,
										value: String
									}
								],
								conditionalValues: 
								[
									String
								],
								selectGetUri: String,
								validation: 
								[
									{
										validationName: String,
										validationLength: 0,
										validationPattern: String
									}
								],
								notifyPubs: 
								[
									{
										notifyType: String,
										notifyEventType: String,
										delay: 0
									}
								],
								notifySubs: 
								[
									{
										notifyType: String,
										notifyActionType: String
									}
								],
								customValidation: 
								{
									customFunctionName: String,
									customParams: 
									[
										String
									]
								},
								placeholder: String,
								type: String,
								value: {},
								validationMessages: 
								{
									String: String
								},
								validationPosition: String,
								hideInitialValidation: False,
								widthClass: String,
								html: String,
								img: String,
								imgWidth: String,
								category: String,
								getUri: String,
								controlStyle: String,
								hasSensitiveData: False,
								debug: False,
								icon: String,
								mask: String,
								postService: 0,
								printType: String,
								radioNames: 
								[
									{
										name: String,
										value: String
									}
								],
								children: 
								[
									{
										disabled: False,
										label: String,
										label2: String,
										name: String,
										options: 
										[
											{
												name: String,
												value: String
											}
										],
										conditionalValues: 
										[
											String
										],
										selectGetUri: String,
										validation: 
										[
											{
												validationName: String,
												validationLength: 0,
												validationPattern: String
											}
										],
										notifyPubs: 
										[
											{
												notifyType: String,
												notifyEventType: String,
												delay: 0
											}
										],
										notifySubs: 
										[
											{
												notifyType: String,
												notifyActionType: String
											}
										],
										customValidation: 
										{
											customFunctionName: String,
											customParams: 
											[
												String
											]
										},
										placeholder: String,
										type: String,
										value: {},
										validationMessages: 
										{
											String: String
										},
										validationPosition: String,
										hideInitialValidation: False,
										widthClass: String,
										html: String,
										img: String,
										imgWidth: String,
										category: String,
										getUri: String,
										controlStyle: String,
										hasSensitiveData: False,
										debug: False,
										icon: String,
										mask: String,
										postService: 0,
										printType: String,
										radioNames: 
										[
											{
												name: String,
												value: String
											}
										]
									}
								]
							}
						]
					}
				],
				childGroup: 
				{
					name: String,
					type: String,
					groupStyle: String,
					debug: False,
					notifyPubs: 
					[
						{
							notifyType: String,
							notifyEventType: String,
							delay: 0
						}
					],
					notifySubs: 
					[
						{
							notifyType: String,
							notifyActionType: String
						}
					],
					controlDetails: 
					[
						{
							disabled: False,
							label: String,
							label2: String,
							name: String,
							options: 
							[
								{
									name: String,
									value: String
								}
							],
							conditionalValues: 
							[
								String
							],
							selectGetUri: String,
							validation: 
							[
								{
									validationName: String,
									validationLength: 0,
									validationPattern: String
								}
							],
							notifyPubs: 
							[
								{
									notifyType: String,
									notifyEventType: String,
									delay: 0
								}
							],
							notifySubs: 
							[
								{
									notifyType: String,
									notifyActionType: String
								}
							],
							customValidation: 
							{
								customFunctionName: String,
								customParams: 
								[
									String
								]
							},
							placeholder: String,
							type: String,
							value: {},
							validationMessages: 
							{
								String: String
							},
							validationPosition: String,
							hideInitialValidation: False,
							widthClass: String,
							html: String,
							img: String,
							imgWidth: String,
							category: String,
							getUri: String,
							controlStyle: String,
							hasSensitiveData: False,
							debug: False,
							icon: String,
							mask: String,
							postService: 0,
							printType: String,
							radioNames: 
							[
								{
									name: String,
									value: String
								}
							],
							children: 
							[
								{
									disabled: False,
									label: String,
									label2: String,
									name: String,
									options: 
									[
										{
											name: String,
											value: String
										}
									],
									conditionalValues: 
									[
										String
									],
									selectGetUri: String,
									validation: 
									[
										{
											validationName: String,
											validationLength: 0,
											validationPattern: String
										}
									],
									notifyPubs: 
									[
										{
											notifyType: String,
											notifyEventType: String,
											delay: 0
										}
									],
									notifySubs: 
									[
										{
											notifyType: String,
											notifyActionType: String
										}
									],
									customValidation: 
									{
										customFunctionName: String,
										customParams: 
										[
											String
										]
									},
									placeholder: String,
									type: String,
									value: {},
									validationMessages: 
									{
										String: String
									},
									validationPosition: String,
									hideInitialValidation: False,
									widthClass: String,
									html: String,
									img: String,
									imgWidth: String,
									category: String,
									getUri: String,
									controlStyle: String,
									hasSensitiveData: False,
									debug: False,
									icon: String,
									mask: String,
									postService: 0,
									printType: String,
									radioNames: 
									[
										{
											name: String,
											value: String
										}
									],
									children: 
									[
										{
											disabled: False,
											label: String,
											label2: String,
											name: String,
											options: 
											[
												{
													name: String,
													value: String
												}
											],
											conditionalValues: 
											[
												String
											],
											selectGetUri: String,
											validation: 
											[
												{
													validationName: String,
													validationLength: 0,
													validationPattern: String
												}
											],
											notifyPubs: 
											[
												{
													notifyType: String,
													notifyEventType: String,
													delay: 0
												}
											],
											notifySubs: 
											[
												{
													notifyType: String,
													notifyActionType: String
												}
											],
											customValidation: 
											{
												customFunctionName: String,
												customParams: 
												[
													String
												]
											},
											placeholder: String,
											type: String,
											value: {},
											validationMessages: 
											{
												String: String
											},
											validationPosition: String,
											hideInitialValidation: False,
											widthClass: String,
											html: String,
											img: String,
											imgWidth: String,
											category: String,
											getUri: String,
											controlStyle: String,
											hasSensitiveData: False,
											debug: False,
											icon: String,
											mask: String,
											postService: 0,
											printType: String,
											radioNames: 
											[
												{
													name: String,
													value: String
												}
											]
										}
									]
								}
							]
						}
					],
					childGroup: 
					{
						name: String,
						type: String,
						groupStyle: String,
						debug: False,
						notifyPubs: 
						[
							{
								notifyType: String,
								notifyEventType: String,
								delay: 0
							}
						],
						notifySubs: 
						[
							{
								notifyType: String,
								notifyActionType: String
							}
						],
						controlDetails: 
						[
							{
								disabled: False,
								label: String,
								label2: String,
								name: String,
								options: 
								[
									{
										name: String,
										value: String
									}
								],
								conditionalValues: 
								[
									String
								],
								selectGetUri: String,
								validation: 
								[
									{
										validationName: String,
										validationLength: 0,
										validationPattern: String
									}
								],
								notifyPubs: 
								[
									{
										notifyType: String,
										notifyEventType: String,
										delay: 0
									}
								],
								notifySubs: 
								[
									{
										notifyType: String,
										notifyActionType: String
									}
								],
								customValidation: 
								{
									customFunctionName: String,
									customParams: 
									[
										String
									]
								},
								placeholder: String,
								type: String,
								value: {},
								validationMessages: 
								{
									String: String
								},
								validationPosition: String,
								hideInitialValidation: False,
								widthClass: String,
								html: String,
								img: String,
								imgWidth: String,
								category: String,
								getUri: String,
								controlStyle: String,
								hasSensitiveData: False,
								debug: False,
								icon: String,
								mask: String,
								postService: 0,
								printType: String,
								radioNames: 
								[
									{
										name: String,
										value: String
									}
								],
								children: 
								[
									{
										disabled: False,
										label: String,
										label2: String,
										name: String,
										options: 
										[
											{
												name: String,
												value: String
											}
										],
										conditionalValues: 
										[
											String
										],
										selectGetUri: String,
										validation: 
										[
											{
												validationName: String,
												validationLength: 0,
												validationPattern: String
											}
										],
										notifyPubs: 
										[
											{
												notifyType: String,
												notifyEventType: String,
												delay: 0
											}
										],
										notifySubs: 
										[
											{
												notifyType: String,
												notifyActionType: String
											}
										],
										customValidation: 
										{
											customFunctionName: String,
											customParams: 
											[
												String
											]
										},
										placeholder: String,
										type: String,
										value: {},
										validationMessages: 
										{
											String: String
										},
										validationPosition: String,
										hideInitialValidation: False,
										widthClass: String,
										html: String,
										img: String,
										imgWidth: String,
										category: String,
										getUri: String,
										controlStyle: String,
										hasSensitiveData: False,
										debug: False,
										icon: String,
										mask: String,
										postService: 0,
										printType: String,
										radioNames: 
										[
											{
												name: String,
												value: String
											}
										],
										children: 
										[
											{
												disabled: False,
												label: String,
												label2: String,
												name: String,
												options: 
												[
													{
														name: String,
														value: String
													}
												],
												conditionalValues: 
												[
													String
												],
												selectGetUri: String,
												validation: 
												[
													{
														validationName: String,
														validationLength: 0,
														validationPattern: String
													}
												],
												notifyPubs: 
												[
													{
														notifyType: String,
														notifyEventType: String,
														delay: 0
													}
												],
												notifySubs: 
												[
													{
														notifyType: String,
														notifyActionType: String
													}
												],
												customValidation: 
												{
													customFunctionName: String,
													customParams: 
													[
														String
													]
												},
												placeholder: String,
												type: String,
												value: {},
												validationMessages: 
												{
													String: String
												},
												validationPosition: String,
												hideInitialValidation: False,
												widthClass: String,
												html: String,
												img: String,
												imgWidth: String,
												category: String,
												getUri: String,
												controlStyle: String,
												hasSensitiveData: False,
												debug: False,
												icon: String,
												mask: String,
												postService: 0,
												printType: String,
												radioNames: 
												[
													{
														name: String,
														value: String
													}
												]
											}
										]
									}
								]
							}
						]
					}
				}
			}
		]
	},
	services: 
	[
		{
			serviceId: 0,
			serviceName: String,
			uri: String,
			serviceType: String,
			initFormState: False,
			serviceDetails: 
			[
				{
					serviceId: 0,
					name: String,
					mappedName: String,
					required: False
				}
			]
		}
	]
}