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 .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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/json
Content-Type: application/json
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: application/json
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"]}]}