Billhighway Cloud API

FormBuilderModelRq

The following routes are available for this service:
POST	/signup/api/formbuilder/model


export class FormBuilderModelNameValue
{
    public Name?: string;
    public Value?: Object;

    public constructor(init?: Partial<FormBuilderModelNameValue>) { (Object as any).assign(this, init); }
}

export class FormBuilderModelRq
{
    public TemplateId?: number;
    public BhUserID?: string;
    public UserType?: string;
    public ClientDocNo?: string;
    public FormType?: string;
    public ConfirmationNumber?: number;
    public NameValues?: FormBuilderModelNameValue[];
    public GroupPlans?: string;
    public natId?: number;
    public chapId?: number;

    public constructor(init?: Partial<FormBuilderModelRq>) { (Object as any).assign(this, init); }
}

export class FormBuilderModelRs
{
    public message?: string;
    public modelStateId?: number;

    public constructor(init?: Partial<FormBuilderModelRs>) { (Object as any).assign(this, init); }
}

TypeScript FormBuilderModelRq 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/formbuilder/model HTTP/1.1 
Host: devapi.billhighway.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<FormBuilderModelRq xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common4.DTO.FormBuilder.Request">
  <BhUserID>String</BhUserID>
  <ClientDocNo>String</ClientDocNo>
  <ConfirmationNumber>0</ConfirmationNumber>
  <FormType>String</FormType>
  <GroupPlans>String</GroupPlans>
  <NameValues>
    <FormBuilderModelNameValue>
      <Name>String</Name>
      <Value />
    </FormBuilderModelNameValue>
  </NameValues>
  <TemplateId>0</TemplateId>
  <UserType>String</UserType>
  <chapId>0</chapId>
  <natId>0</natId>
</FormBuilderModelRq>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<FormBuilderModelRs xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common4.DTO.FormBuilder.Response">
  <message>String</message>
  <modelStateId>0</modelStateId>
</FormBuilderModelRs>