Billhighway Cloud API

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}

Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports BH.CloudAPI.Common4.DTO.FormBuilder.Request
Imports BH.CloudAPI.Common4.DTO.FormBuilder.Response
Imports BH.API.DataAccess.Pipeline

Namespace Global

    Namespace BH.API.DataAccess.Pipeline

        Public Partial Class BhWorkflowComponentDto
            Public Sub New()
                Warnings = New List(Of String)
            End Sub

            Public Overridable Property ComponentName As String
            Public Overridable Property HasServerError As Boolean
            Public Overridable Property HasClientError As Boolean
            Public Overridable Property HasWarningError As Boolean
            Public Overridable Property Warnings As List(Of String)
        End Class

        Public Partial Class BhWorkflowOutputDto
            Public Overridable Property name As String
            Public Overridable Property value As String
        End Class
    End Namespace

    Namespace BH.CloudAPI.Common4.DTO.FormBuilder.Request

        Public Partial Class FormBuilderMembershipPipelineRevenuePricingRq
            Public Overridable Property nationalId As Integer
            Public Overridable Property groupId As Nullable(Of Integer)
            Public Overridable Property workflowTemplateTypeId As Integer
            Public Overridable Property workflowCategoryKey As String
            Public Overridable Property workflowTypeId As Integer
            Public Overridable Property revenue As String
            Public Overridable Property subscriptionInvoiceId As String
            Public Overridable Property yearsOfService As String
            Public Overridable Property termTypeId As String
        End Class
    End Namespace

    Namespace BH.CloudAPI.Common4.DTO.FormBuilder.Response

        Public Partial Class FormBuilderMembershipPipelineRs
            Public Sub New()
                outputs = New List(Of BhWorkflowOutputDto)
                components = New List(Of BhWorkflowComponentDto)
            End Sub

            Public Overridable Property workflowId As Long
            Public Overridable Property isValid As Boolean
            Public Overridable Property hasServerError As Boolean
            Public Overridable Property hasClientError As Boolean
            Public Overridable Property hasWarningError As Boolean
            Public Overridable Property clientErrors As String
            Public Overridable Property warningErrors As String
            Public Overridable Property outputs As List(Of BhWorkflowOutputDto)
            Public Overridable Property components As List(Of BhWorkflowComponentDto)
        End Class
    End Namespace
End Namespace

VB.NET FormBuilderMembershipPipelineRevenuePricingRq 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.

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