Billhighway Cloud API

<back to all web services

FormBuilderModelRq

The following routes are available for this service:
POST/signup/api/formbuilder/model
import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    public static class FormBuilderModelRq
    {
        public Integer TemplateId = null;
        public String BhUserID = null;
        public String UserType = null;
        public String ClientDocNo = null;
        public String FormType = null;
        public Integer ConfirmationNumber = null;
        public ArrayList<FormBuilderModelNameValue> NameValues = null;
        public String GroupPlans = null;
        public Integer natId = null;
        public Integer chapId = null;
        
        public Integer getTemplateId() { return TemplateId; }
        public FormBuilderModelRq setTemplateId(Integer value) { this.TemplateId = value; return this; }
        public String getBhUserID() { return BhUserID; }
        public FormBuilderModelRq setBhUserID(String value) { this.BhUserID = value; return this; }
        public String getUserType() { return UserType; }
        public FormBuilderModelRq setUserType(String value) { this.UserType = value; return this; }
        public String getClientDocNo() { return ClientDocNo; }
        public FormBuilderModelRq setClientDocNo(String value) { this.ClientDocNo = value; return this; }
        public String getFormType() { return FormType; }
        public FormBuilderModelRq setFormType(String value) { this.FormType = value; return this; }
        public Integer getConfirmationNumber() { return ConfirmationNumber; }
        public FormBuilderModelRq setConfirmationNumber(Integer value) { this.ConfirmationNumber = value; return this; }
        public ArrayList<FormBuilderModelNameValue> getNameValues() { return NameValues; }
        public FormBuilderModelRq setNameValues(ArrayList<FormBuilderModelNameValue> value) { this.NameValues = value; return this; }
        public String getGroupPlans() { return GroupPlans; }
        public FormBuilderModelRq setGroupPlans(String value) { this.GroupPlans = value; return this; }
        public Integer getNatId() { return natId; }
        public FormBuilderModelRq setNatId(Integer value) { this.natId = value; return this; }
        public Integer getChapId() { return chapId; }
        public FormBuilderModelRq setChapId(Integer value) { this.chapId = value; return this; }
    }

    public static class FormBuilderModelNameValue
    {
        public String Name = null;
        public Object Value = null;
        
        public String getName() { return Name; }
        public FormBuilderModelNameValue setName(String value) { this.Name = value; return this; }
        public Object getValue() { return Value; }
        public FormBuilderModelNameValue setValue(Object value) { this.Value = value; return this; }
    }

    public static class FormBuilderModelRs
    {
        public String message = null;
        public Integer modelStateId = null;
        
        public String getMessage() { return message; }
        public FormBuilderModelRs setMessage(String value) { this.message = value; return this; }
        public Integer getModelStateId() { return modelStateId; }
        public FormBuilderModelRs setModelStateId(Integer value) { this.modelStateId = value; return this; }
    }

}

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