Billhighway Cloud API

FormBuilderMembershipPipelineRq

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

import Foundation
import ServiceStack

public class FormBuilderMembershipPipelineRq : IApiRequest, Codable
{
    public var nationalId:Int?
    public var chapId:Int?
    public var workflowTemplateTypeId:Int?
    public var workflowCategoryKey:String?
    public var createdBy:Int?
    public var properties:[BhWorkflowPropertyDto] = []

    required public init(){}
}

public class BhWorkflowPropertyDto : Codable
{
    public var name:String?
    public var value:String?
    public var propertyNamespace:String?

    required public init(){}
}

public class FormBuilderMembershipPipelineRs : Codable
{
    public var workflowId:Int?
    public var isValid:Bool?
    public var hasServerError:Bool?
    public var hasClientError:Bool?
    public var hasWarningError:Bool?
    public var clientErrors:String?
    public var warningErrors:String?
    public var outputs:[BhWorkflowOutputDto] = []
    public var components:[BhWorkflowComponentDto] = []

    required public init(){}
}

public class BhWorkflowOutputDto : Codable
{
    public var name:String?
    public var value:String?

    required public init(){}
}

public class BhWorkflowComponentDto : Codable
{
    public var componentName:String?
    public var hasServerError:Bool?
    public var hasClientError:Bool?
    public var hasWarningError:Bool?
    public var warnings:[String] = []

    required public init(){}
}

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