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 'package:servicestack/servicestack.dart';

class BhWorkflowPropertyDto implements IConvertible
{
    String? name;
    String? value;
    String? propertyNamespace;

    BhWorkflowPropertyDto({this.name,this.value,this.propertyNamespace});
    BhWorkflowPropertyDto.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        name = json['name'];
        value = json['value'];
        propertyNamespace = json['propertyNamespace'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'name': name,
        'value': value,
        'propertyNamespace': propertyNamespace
    };

    getTypeName() => "BhWorkflowPropertyDto";
    TypeContext? context = _ctx;
}

class FormBuilderMembershipPipelineRq implements IApiRequest, IConvertible
{
    int? nationalId;
    int? chapId;
    int? workflowTemplateTypeId;
    String? workflowCategoryKey;
    int? createdBy;
    List<BhWorkflowPropertyDto>? properties;

    FormBuilderMembershipPipelineRq({this.nationalId,this.chapId,this.workflowTemplateTypeId,this.workflowCategoryKey,this.createdBy,this.properties});
    FormBuilderMembershipPipelineRq.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        nationalId = json['nationalId'];
        chapId = json['chapId'];
        workflowTemplateTypeId = json['workflowTemplateTypeId'];
        workflowCategoryKey = json['workflowCategoryKey'];
        createdBy = json['createdBy'];
        properties = JsonConverters.fromJson(json['properties'],'List<BhWorkflowPropertyDto>',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'nationalId': nationalId,
        'chapId': chapId,
        'workflowTemplateTypeId': workflowTemplateTypeId,
        'workflowCategoryKey': workflowCategoryKey,
        'createdBy': createdBy,
        'properties': JsonConverters.toJson(properties,'List<BhWorkflowPropertyDto>',context!)
    };

    getTypeName() => "FormBuilderMembershipPipelineRq";
    TypeContext? context = _ctx;
}

class BhWorkflowOutputDto implements IConvertible
{
    String? name;
    String? value;

    BhWorkflowOutputDto({this.name,this.value});
    BhWorkflowOutputDto.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        name = json['name'];
        value = json['value'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'name': name,
        'value': value
    };

    getTypeName() => "BhWorkflowOutputDto";
    TypeContext? context = _ctx;
}

class BhWorkflowComponentDto implements IConvertible
{
    String? ComponentName;
    bool? HasServerError;
    bool? HasClientError;
    bool? HasWarningError;
    List<String>? Warnings;

    BhWorkflowComponentDto({this.ComponentName,this.HasServerError,this.HasClientError,this.HasWarningError,this.Warnings});
    BhWorkflowComponentDto.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        ComponentName = json['ComponentName'];
        HasServerError = json['HasServerError'];
        HasClientError = json['HasClientError'];
        HasWarningError = json['HasWarningError'];
        Warnings = JsonConverters.fromJson(json['Warnings'],'List<String>',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'ComponentName': ComponentName,
        'HasServerError': HasServerError,
        'HasClientError': HasClientError,
        'HasWarningError': HasWarningError,
        'Warnings': JsonConverters.toJson(Warnings,'List<String>',context!)
    };

    getTypeName() => "BhWorkflowComponentDto";
    TypeContext? context = _ctx;
}

class FormBuilderMembershipPipelineRs implements IConvertible
{
    int? workflowId;
    bool? isValid;
    bool? hasServerError;
    bool? hasClientError;
    bool? hasWarningError;
    String? clientErrors;
    String? warningErrors;
    List<BhWorkflowOutputDto>? outputs;
    List<BhWorkflowComponentDto>? components;

    FormBuilderMembershipPipelineRs({this.workflowId,this.isValid,this.hasServerError,this.hasClientError,this.hasWarningError,this.clientErrors,this.warningErrors,this.outputs,this.components});
    FormBuilderMembershipPipelineRs.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        workflowId = json['workflowId'];
        isValid = json['isValid'];
        hasServerError = json['hasServerError'];
        hasClientError = json['hasClientError'];
        hasWarningError = json['hasWarningError'];
        clientErrors = json['clientErrors'];
        warningErrors = json['warningErrors'];
        outputs = JsonConverters.fromJson(json['outputs'],'List<BhWorkflowOutputDto>',context!);
        components = JsonConverters.fromJson(json['components'],'List<BhWorkflowComponentDto>',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'workflowId': workflowId,
        'isValid': isValid,
        'hasServerError': hasServerError,
        'hasClientError': hasClientError,
        'hasWarningError': hasWarningError,
        'clientErrors': clientErrors,
        'warningErrors': warningErrors,
        'outputs': JsonConverters.toJson(outputs,'List<BhWorkflowOutputDto>',context!),
        'components': JsonConverters.toJson(components,'List<BhWorkflowComponentDto>',context!)
    };

    getTypeName() => "FormBuilderMembershipPipelineRs";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'devapi.billhighway.com', types: <String, TypeInfo> {
    'BhWorkflowPropertyDto': TypeInfo(TypeOf.Class, create:() => BhWorkflowPropertyDto()),
    'FormBuilderMembershipPipelineRq': TypeInfo(TypeOf.Class, create:() => FormBuilderMembershipPipelineRq()),
    'List<BhWorkflowPropertyDto>': TypeInfo(TypeOf.Class, create:() => <BhWorkflowPropertyDto>[]),
    'BhWorkflowOutputDto': TypeInfo(TypeOf.Class, create:() => BhWorkflowOutputDto()),
    'BhWorkflowComponentDto': TypeInfo(TypeOf.Class, create:() => BhWorkflowComponentDto()),
    'FormBuilderMembershipPipelineRs': TypeInfo(TypeOf.Class, create:() => FormBuilderMembershipPipelineRs()),
    'List<BhWorkflowOutputDto>': TypeInfo(TypeOf.Class, create:() => <BhWorkflowOutputDto>[]),
    'List<BhWorkflowComponentDto>': TypeInfo(TypeOf.Class, create:() => <BhWorkflowComponentDto>[]),
});

Dart 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>