Billhighway Cloud API

<back to all web services

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

{"TemplateId":0,"BhUserID":"String","UserType":"String","ClientDocNo":"String","FormType":"String","ConfirmationNumber":0,"NameValues":[{"Name":"String","Value":{}}],"GroupPlans":"String","natId":0,"chapId":0}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"message":"String","modelStateId":0}