Billhighway Cloud API

<back to all web services

FormBuilderMembershipPipelineRq

The following routes are available for this service:
POST/signup/api/nat/{nationalId}/group/{chapId}/membershipPipeline
import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    public static class FormBuilderMembershipPipelineRq implements IApiRequest
    {
        public Integer nationalId = null;
        public Integer chapId = null;
        public Integer workflowTemplateTypeId = null;
        public String workflowCategoryKey = null;
        public Integer createdBy = null;
        public ArrayList<BhWorkflowPropertyDto> properties = null;
        
        public Integer getNationalId() { return nationalId; }
        public FormBuilderMembershipPipelineRq setNationalId(Integer value) { this.nationalId = value; return this; }
        public Integer getChapId() { return chapId; }
        public FormBuilderMembershipPipelineRq setChapId(Integer value) { this.chapId = value; return this; }
        public Integer getWorkflowTemplateTypeId() { return workflowTemplateTypeId; }
        public FormBuilderMembershipPipelineRq setWorkflowTemplateTypeId(Integer value) { this.workflowTemplateTypeId = value; return this; }
        public String getWorkflowCategoryKey() { return workflowCategoryKey; }
        public FormBuilderMembershipPipelineRq setWorkflowCategoryKey(String value) { this.workflowCategoryKey = value; return this; }
        public Integer getCreatedBy() { return createdBy; }
        public FormBuilderMembershipPipelineRq setCreatedBy(Integer value) { this.createdBy = value; return this; }
        public ArrayList<BhWorkflowPropertyDto> getProperties() { return properties; }
        public FormBuilderMembershipPipelineRq setProperties(ArrayList<BhWorkflowPropertyDto> value) { this.properties = value; return this; }
    }

    public static class BhWorkflowPropertyDto
    {
        public String name = null;
        public String value = null;
        public String propertyNamespace = null;
        
        public String getName() { return name; }
        public BhWorkflowPropertyDto setName(String value) { this.name = value; return this; }
        public String getValue() { return value; }
        public BhWorkflowPropertyDto setValue(String value) { this.value = value; return this; }
        public String getPropertyNamespace() { return propertyNamespace; }
        public BhWorkflowPropertyDto setPropertyNamespace(String value) { this.propertyNamespace = value; return this; }
    }

    public static class FormBuilderMembershipPipelineRs
    {
        public Long workflowId = null;
        public Boolean isValid = null;
        public Boolean hasServerError = null;
        public Boolean hasClientError = null;
        public Boolean hasWarningError = null;
        public String clientErrors = null;
        public String warningErrors = null;
        public ArrayList<BhWorkflowOutputDto> outputs = null;
        public ArrayList<BhWorkflowComponentDto> components = null;
        
        public Long getWorkflowId() { return workflowId; }
        public FormBuilderMembershipPipelineRs setWorkflowId(Long value) { this.workflowId = value; return this; }
        public Boolean getIsValid() { return isValid; }
        public FormBuilderMembershipPipelineRs setIsValid(Boolean value) { this.isValid = value; return this; }
        public Boolean isHasServerError() { return hasServerError; }
        public FormBuilderMembershipPipelineRs setHasServerError(Boolean value) { this.hasServerError = value; return this; }
        public Boolean isHasClientError() { return hasClientError; }
        public FormBuilderMembershipPipelineRs setHasClientError(Boolean value) { this.hasClientError = value; return this; }
        public Boolean isHasWarningError() { return hasWarningError; }
        public FormBuilderMembershipPipelineRs setHasWarningError(Boolean value) { this.hasWarningError = value; return this; }
        public String getClientErrors() { return clientErrors; }
        public FormBuilderMembershipPipelineRs setClientErrors(String value) { this.clientErrors = value; return this; }
        public String getWarningErrors() { return warningErrors; }
        public FormBuilderMembershipPipelineRs setWarningErrors(String value) { this.warningErrors = value; return this; }
        public ArrayList<BhWorkflowOutputDto> getOutputs() { return outputs; }
        public FormBuilderMembershipPipelineRs setOutputs(ArrayList<BhWorkflowOutputDto> value) { this.outputs = value; return this; }
        public ArrayList<BhWorkflowComponentDto> getComponents() { return components; }
        public FormBuilderMembershipPipelineRs setComponents(ArrayList<BhWorkflowComponentDto> value) { this.components = value; return this; }
    }

    public static class BhWorkflowOutputDto
    {
        public String name = null;
        public String value = null;
        
        public String getName() { return name; }
        public BhWorkflowOutputDto setName(String value) { this.name = value; return this; }
        public String getValue() { return value; }
        public BhWorkflowOutputDto setValue(String value) { this.value = value; return this; }
    }

    public static class BhWorkflowComponentDto
    {
        public String ComponentName = null;
        public Boolean HasServerError = null;
        public Boolean HasClientError = null;
        public Boolean HasWarningError = null;
        public ArrayList<String> Warnings = null;
        
        public String getComponentName() { return ComponentName; }
        public BhWorkflowComponentDto setComponentName(String value) { this.ComponentName = value; return this; }
        public Boolean isHasServerError() { return HasServerError; }
        public BhWorkflowComponentDto setHasServerError(Boolean value) { this.HasServerError = value; return this; }
        public Boolean isHasClientError() { return HasClientError; }
        public BhWorkflowComponentDto setHasClientError(Boolean value) { this.HasClientError = value; return this; }
        public Boolean isHasWarningError() { return HasWarningError; }
        public BhWorkflowComponentDto setHasWarningError(Boolean value) { this.HasWarningError = value; return this; }
        public ArrayList<String> getWarnings() { return Warnings; }
        public BhWorkflowComponentDto setWarnings(ArrayList<String> value) { this.Warnings = value; return this; }
    }

}

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