Billhighway Cloud API

<back to all web services

FormBuilderModelRq

The following routes are available for this service:
POST/signup/api/formbuilder/model
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using BH.CloudAPI.Common4.DTO.FormBuilder.Request;
using BH.CloudAPI.Common4.DTO.FormBuilder.Response;

namespace BH.CloudAPI.Common4.DTO.FormBuilder.Request
{
    public partial class FormBuilderModelNameValue
    {
        public virtual string Name { get; set; }
        public virtual Object Value { get; set; }
    }

    public partial class FormBuilderModelRq
    {
        public FormBuilderModelRq()
        {
            NameValues = new List<FormBuilderModelNameValue>{};
        }

        public virtual int TemplateId { get; set; }
        public virtual string BhUserID { get; set; }
        public virtual string UserType { get; set; }
        public virtual string ClientDocNo { get; set; }
        public virtual string FormType { get; set; }
        public virtual int ConfirmationNumber { get; set; }
        public virtual List<FormBuilderModelNameValue> NameValues { get; set; }
        public virtual string GroupPlans { get; set; }
        public virtual int natId { get; set; }
        public virtual int chapId { get; set; }
    }

}

namespace BH.CloudAPI.Common4.DTO.FormBuilder.Response
{
    public partial class FormBuilderModelRs
    {
        public virtual string message { get; set; }
        public virtual int modelStateId { get; set; }
    }

}

C# 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>