Billhighway Cloud API

FormBuilderMembershipPipelineRq

The following routes are available for this service:
POST	/signup/api/nat/{nationalId}/group/{chapId}/membershipPipeline


export class BhWorkflowPropertyDto
{
    public name?: string;
    public value?: string;
    public propertyNamespace?: string;

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

export class FormBuilderMembershipPipelineRq implements IApiRequest
{
    public nationalId?: number;
    public chapId?: number;
    public workflowTemplateTypeId?: number;
    public workflowCategoryKey?: string;
    public createdBy?: number;
    public properties?: BhWorkflowPropertyDto[];

    public constructor(init?: Partial<FormBuilderMembershipPipelineRq>) { (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 FormBuilderMembershipPipelineRq 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.

POST /signup/api/nat/{nationalId}/group/{chapId}/membershipPipeline HTTP/1.1 
Host: devapi.billhighway.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	nationalId: 0,
	chapId: 0,
	workflowTemplateTypeId: 0,
	workflowCategoryKey: String,
	createdBy: 0,
	properties: 
	[
		{
			name: String,
			value: String,
			propertyNamespace: String
		}
	]
}

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