Billhighway Cloud API

<back to all web services

FormBuilderModelRq

The following routes are available for this service:
POST/signup/api/formbuilder/model
namespace BH.CloudAPI.Common4.DTO.FormBuilder.Request

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type FormBuilderModelNameValue() = 
        member val Name:String = null with get,set
        member val Value:Object = null with get,set

    [<AllowNullLiteral>]
    type FormBuilderModelRq() = 
        member val TemplateId:Int32 = new Int32() with get,set
        member val BhUserID:String = null with get,set
        member val UserType:String = null with get,set
        member val ClientDocNo:String = null with get,set
        member val FormType:String = null with get,set
        member val ConfirmationNumber:Int32 = new Int32() with get,set
        member val NameValues:ResizeArray<FormBuilderModelNameValue> = new ResizeArray<FormBuilderModelNameValue>() with get,set
        member val GroupPlans:String = null with get,set
        member val natId:Int32 = new Int32() with get,set
        member val chapId:Int32 = new Int32() with get,set

    [<AllowNullLiteral>]
    type FormBuilderModelRs() = 
        member val message:String = null with get,set
        member val modelStateId:Int32 = new Int32() with get,set

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