Billhighway Cloud API

FormBuilderMembershipPipelineRq

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

import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class BhWorkflowPropertyDto:
    name: Optional[str] = None
    value: Optional[str] = None
    property_namespace: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class FormBuilderMembershipPipelineRq(IApiRequest):
    national_id: Optional[int] = None
    chap_id: Optional[int] = None
    workflow_template_type_id: Optional[int] = None
    workflow_category_key: Optional[str] = None
    created_by: Optional[int] = None
    properties: Optional[List[BhWorkflowPropertyDto]] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class BhWorkflowOutputDto:
    name: Optional[str] = None
    value: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class BhWorkflowComponentDto:
    component_name: Optional[str] = None
    has_server_error: Optional[bool] = None
    has_client_error: Optional[bool] = None
    has_warning_error: Optional[bool] = None
    warnings: Optional[List[str]] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class FormBuilderMembershipPipelineRs:
    workflow_id: Optional[int] = None
    is_valid: Optional[bool] = None
    has_server_error: Optional[bool] = None
    has_client_error: Optional[bool] = None
    has_warning_error: Optional[bool] = None
    client_errors: Optional[str] = None
    warning_errors: Optional[str] = None
    outputs: Optional[List[BhWorkflowOutputDto]] = None
    components: Optional[List[BhWorkflowComponentDto]] = None

Python 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"]}]}