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 .jsv suffix or ?format=jsv

HTTP + JSV

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: text/jsv
Content-Type: text/jsv
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: text/jsv
Content-Length: length

{
	message: String,
	modelStateId: 0
}