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
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using BH.CloudAPI.Common4.DTO.FormBuilder.Request;
using BH.API.DataAccess.Pipeline;
using BH.CloudAPI.Common4.DTO.FormBuilder.Response;

namespace BH.API.DataAccess.Pipeline
{
    public partial class BhWorkflowComponentDto
    {
        public BhWorkflowComponentDto()
        {
            Warnings = new List<string>{};
        }

        public virtual string ComponentName { get; set; }
        public virtual bool HasServerError { get; set; }
        public virtual bool HasClientError { get; set; }
        public virtual bool HasWarningError { get; set; }
        public virtual List<string> Warnings { get; set; }
    }

    public partial class BhWorkflowOutputDto
    {
        public virtual string name { get; set; }
        public virtual string value { get; set; }
    }

    public partial class BhWorkflowPropertyDto
    {
        public virtual string name { get; set; }
        public virtual string value { get; set; }
        public virtual string propertyNamespace { get; set; }
    }

}

namespace BH.CloudAPI.Common4.DTO.FormBuilder.Request
{
    public partial class FormBuilderMembershipPipelineRq
        : IApiRequest
    {
        public FormBuilderMembershipPipelineRq()
        {
            properties = new List<BhWorkflowPropertyDto>{};
        }

        public virtual int nationalId { get; set; }
        public virtual int chapId { get; set; }
        public virtual int workflowTemplateTypeId { get; set; }
        public virtual string workflowCategoryKey { get; set; }
        public virtual int createdBy { get; set; }
        public virtual List<BhWorkflowPropertyDto> properties { get; set; }
    }

}

namespace BH.CloudAPI.Common4.DTO.FormBuilder.Response
{
    public partial class FormBuilderMembershipPipelineRs
    {
        public FormBuilderMembershipPipelineRs()
        {
            outputs = new List<BhWorkflowOutputDto>{};
            components = new List<BhWorkflowComponentDto>{};
        }

        public virtual long workflowId { get; set; }
        public virtual bool isValid { get; set; }
        public virtual bool hasServerError { get; set; }
        public virtual bool hasClientError { get; set; }
        public virtual bool hasWarningError { get; set; }
        public virtual string clientErrors { get; set; }
        public virtual string warningErrors { get; set; }
        public virtual List<BhWorkflowOutputDto> outputs { get; set; }
        public virtual List<BhWorkflowComponentDto> components { get; set; }
    }

}

C# FormBuilderMembershipPipelineRq DTOs

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>