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}

import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class FormBuilderMembershipPipelineRevenuePricingRq:
    national_id: Optional[int] = None
    group_id: Optional[int] = None
    workflow_template_type_id: Optional[int] = None
    workflow_category_key: Optional[str] = None
    workflow_type_id: Optional[int] = None
    revenue: Optional[str] = None
    subscription_invoice_id: Optional[str] = None
    years_of_service: Optional[str] = None
    term_type_id: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class BhWorkflowOutputDto:
    name: Optional[str] = None
    value: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class BhWorkflowComponentDto:
    component_name: Optional[str] = None
    has_server_error: Optional[bool] = None
    has_client_error: Optional[bool] = None
    has_warning_error: Optional[bool] = None
    warnings: Optional[List[str]] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class FormBuilderMembershipPipelineRs:
    workflow_id: Optional[int] = None
    is_valid: Optional[bool] = None
    has_server_error: Optional[bool] = None
    has_client_error: Optional[bool] = None
    has_warning_error: Optional[bool] = None
    client_errors: Optional[str] = None
    warning_errors: Optional[str] = None
    outputs: Optional[List[BhWorkflowOutputDto]] = None
    components: Optional[List[BhWorkflowComponentDto]] = None

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