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