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}


export class FormBuilderMembershipPipelineRevenuePricingRq
{
    public nationalId?: number;
    public groupId?: number;
    public workflowTemplateTypeId?: number;
    public workflowCategoryKey?: string;
    public workflowTypeId?: number;
    public revenue?: string;
    public subscriptionInvoiceId?: string;
    public yearsOfService?: string;
    public termTypeId?: string;

    public constructor(init?: Partial<FormBuilderMembershipPipelineRevenuePricingRq>) { (Object as any).assign(this, init); }
}

export class BhWorkflowOutputDto
{
    public name?: string;
    public value?: string;

    public constructor(init?: Partial<BhWorkflowOutputDto>) { (Object as any).assign(this, init); }
}

export class BhWorkflowComponentDto
{
    public ComponentName?: string;
    public HasServerError?: boolean;
    public HasClientError?: boolean;
    public HasWarningError?: boolean;
    public Warnings?: string[];

    public constructor(init?: Partial<BhWorkflowComponentDto>) { (Object as any).assign(this, init); }
}

export class FormBuilderMembershipPipelineRs
{
    public workflowId?: number;
    public isValid?: boolean;
    public hasServerError?: boolean;
    public hasClientError?: boolean;
    public hasWarningError?: boolean;
    public clientErrors?: string;
    public warningErrors?: string;
    public outputs?: BhWorkflowOutputDto[];
    public components?: BhWorkflowComponentDto[];

    public constructor(init?: Partial<FormBuilderMembershipPipelineRs>) { (Object as any).assign(this, init); }
}

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