Billhighway Cloud API

FormBuilderMembershipPipelineRq

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

**FormBuilderMembershipPipelineRq** Parameters:
Name	Parameter	Data Type	Required
nationalId	path	int	No
chapId	path	int	No
workflowTemplateTypeId	body	int	No
workflowCategoryKey	body	string	No
createdBy	body	int	No
properties	body	List<BhWorkflowPropertyDto>	No

**BhWorkflowPropertyDto** Parameters:
Name	Parameter	Data Type	Required
name	form	string	No
value	form	string	No
propertyNamespace	form	string	No

**FormBuilderMembershipPipelineRs** Parameters:
Name	Parameter	Data Type	Required
workflowId	form	long	No
isValid	form	bool	No
hasServerError	form	bool	No
hasClientError	form	bool	No
hasWarningError	form	bool	No
clientErrors	form	string	No
warningErrors	form	string	No
outputs	form	List<BhWorkflowOutputDto>	No
components	form	List<BhWorkflowComponentDto>	No

**BhWorkflowOutputDto** Parameters:
Name	Parameter	Data Type	Required	Description
name	form	string	No
value	form	string	No

**BhWorkflowComponentDto** Parameters:
Name	Parameter	Data Type	Required
ComponentName	form	string	No
HasServerError	form	bool	No
HasClientError	form	bool	No
HasWarningError	form	bool	No
Warnings	form	List<string>	No

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

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: application/xml
Content-Type: application/xml
Content-Length: length

<FormBuilderMembershipPipelineRq xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common4.DTO.FormBuilder.Request">
  <chapId>0</chapId>
  <createdBy>0</createdBy>
  <nationalId>0</nationalId>
  <properties xmlns:d2p1="http://schemas.datacontract.org/2004/07/BH.API.DataAccess.Pipeline">
    <d2p1:BhWorkflowPropertyDto>
      <d2p1:name>String</d2p1:name>
      <d2p1:propertyNamespace>String</d2p1:propertyNamespace>
      <d2p1:value>String</d2p1:value>
    </d2p1:BhWorkflowPropertyDto>
  </properties>
  <workflowCategoryKey>String</workflowCategoryKey>
  <workflowTemplateTypeId>0</workflowTemplateTypeId>
</FormBuilderMembershipPipelineRq>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<FormBuilderMembershipPipelineRs xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common4.DTO.FormBuilder.Response">
  <clientErrors>String</clientErrors>
  <components xmlns:d2p1="http://schemas.datacontract.org/2004/07/BH.API.DataAccess.Pipeline">
    <d2p1:BhWorkflowComponentDto>
      <d2p1:ComponentName>String</d2p1:ComponentName>
      <d2p1:HasClientError>false</d2p1:HasClientError>
      <d2p1:HasServerError>false</d2p1:HasServerError>
      <d2p1:HasWarningError>false</d2p1:HasWarningError>
      <d2p1:Warnings xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1:string>
      </d2p1:Warnings>
    </d2p1:BhWorkflowComponentDto>
  </components>
  <hasClientError>false</hasClientError>
  <hasServerError>false</hasServerError>
  <hasWarningError>false</hasWarningError>
  <isValid>false</isValid>
  <outputs xmlns:d2p1="http://schemas.datacontract.org/2004/07/BH.API.DataAccess.Pipeline">
    <d2p1:BhWorkflowOutputDto>
      <d2p1:name>String</d2p1:name>
      <d2p1:value>String</d2p1:value>
    </d2p1:BhWorkflowOutputDto>
  </outputs>
  <warningErrors>String</warningErrors>
  <workflowId>0</workflowId>
</FormBuilderMembershipPipelineRs>