Billhighway Cloud API

<back to all web services

FormBuilderMembershipPipelineRevenuePricingRq

The following routes are available for this service:
GET/signup/api/nat/{nationalId}/group/{groupId}/templateType/{workflowTemplateTypeId}/key/{workflowCategoryKey}/type/{workflowTypeId}/revenue/{revenue}/subscription/{subscriptionInvoiceId}/years/{yearsOfService}/term/{termTypeId}
FormBuilderMembershipPipelineRevenuePricingRq Parameters:
NameParameterData TypeRequiredDescription
nationalIdpathintNo
groupIdpathint?No
workflowTemplateTypeIdpathintNo
workflowCategoryKeypathstringNo
workflowTypeIdpathintNo
revenuepathstringNo
subscriptionInvoiceIdpathstringNo
yearsOfServicepathstringNo
termTypeIdpathstringNo
FormBuilderMembershipPipelineRs Parameters:
NameParameterData TypeRequiredDescription
workflowIdformlongNo
isValidformboolNo
hasServerErrorformboolNo
hasClientErrorformboolNo
hasWarningErrorformboolNo
clientErrorsformstringNo
warningErrorsformstringNo
outputsformList<BhWorkflowOutputDto>No
componentsformList<BhWorkflowComponentDto>No
BhWorkflowOutputDto Parameters:
NameParameterData TypeRequiredDescription
nameformstringNo
valueformstringNo
BhWorkflowComponentDto Parameters:
NameParameterData TypeRequiredDescription
ComponentNameformstringNo
HasServerErrorformboolNo
HasClientErrorformboolNo
HasWarningErrorformboolNo
WarningsformList<string>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/{nationalId}/group/{groupId}/templateType/{workflowTemplateTypeId}/key/{workflowCategoryKey}/type/{workflowTypeId}/revenue/{revenue}/subscription/{subscriptionInvoiceId}/years/{yearsOfService}/term/{termTypeId} HTTP/1.1 
Host: devapi.billhighway.com 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	workflowId: 0,
	isValid: False,
	hasServerError: False,
	hasClientError: False,
	hasWarningError: False,
	clientErrors: String,
	warningErrors: String,
	outputs: 
	[
		{
			name: String,
			value: String
		}
	],
	components: 
	[
		{
			ComponentName: String,
			HasServerError: False,
			HasClientError: False,
			HasWarningError: False,
			Warnings: 
			[
				String
			]
		}
	]
}