Billhighway Cloud API

FormBuilderMembershipPipelineRq

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

namespace BH.API.DataAccess.Pipeline

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type BhWorkflowPropertyDto() = 
        member val name:String = null with get,set
        member val value:String = null with get,set
        member val propertyNamespace:String = null with get,set

    [<AllowNullLiteral>]
    type FormBuilderMembershipPipelineRq() = 
        member val nationalId:Int32 = new Int32() with get,set
        member val chapId:Int32 = new Int32() with get,set
        member val workflowTemplateTypeId:Int32 = new Int32() with get,set
        member val workflowCategoryKey:String = null with get,set
        member val createdBy:Int32 = new Int32() with get,set
        member val properties:ResizeArray<BhWorkflowPropertyDto> = new ResizeArray<BhWorkflowPropertyDto>() with get,set

    [<AllowNullLiteral>]
    type BhWorkflowOutputDto() = 
        member val name:String = null with get,set
        member val value:String = null with get,set

    [<AllowNullLiteral>]
    type BhWorkflowComponentDto() = 
        member val ComponentName:String = null with get,set
        member val HasServerError:Boolean = new Boolean() with get,set
        member val HasClientError:Boolean = new Boolean() with get,set
        member val HasWarningError:Boolean = new Boolean() with get,set
        member val Warnings:ResizeArray<String> = new ResizeArray<String>() with get,set

    [<AllowNullLiteral>]
    type FormBuilderMembershipPipelineRs() = 
        member val workflowId:Int64 = new Int64() with get,set
        member val isValid:Boolean = new Boolean() with get,set
        member val hasServerError:Boolean = new Boolean() with get,set
        member val hasClientError:Boolean = new Boolean() with get,set
        member val hasWarningError:Boolean = new Boolean() with get,set
        member val clientErrors:String = null with get,set
        member val warningErrors:String = null with get,set
        member val outputs:ResizeArray<BhWorkflowOutputDto> = new ResizeArray<BhWorkflowOutputDto>() with get,set
        member val components:ResizeArray<BhWorkflowComponentDto> = new ResizeArray<BhWorkflowComponentDto>() with get,set

F# FormBuilderMembershipPipelineRq DTOs

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

HTTP + CSV

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/csv
Content-Type: text/csv
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/csv
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"]}]}