Billhighway Cloud API

<back to all web services

FormBuilderHistoryRq

The following routes are available for this service:
GET/signup/api/nat/{natID}/group/{groupId}/{usertype}/user/{userid}/formBuilderHistory/type/{FormBuilderTypeID}/info
GET/signup/api/nat/{natID}/formBuilderHistory/type/{FormBuilderTypeID}/info
import java.math.*
import java.util.*
import net.servicestack.client.*
import com.google.gson.annotations.*
import com.google.gson.reflect.*


open class FormBuilderHistoryRq : IApiRequest
{
    var NatID:Int? = null
    var GroupId:Int? = null
    var FormBuilderTypeID:Int? = null
    var UserType:String? = null
    var UserId:String? = null
}

open class FormBuilderHistoryRs : IApiResponse
{
    var form:BhFormDto? = null
}

open class BhFormDto
{
    var templateId:Int? = null
    var groups:ArrayList<BhGroupDto> = ArrayList<BhGroupDto>()
}

open class BhGroupDto
{
    var name:String? = null
    @SerializedName("type") var Type:String? = null
    var groupStyle:String? = null
    var debug:Boolean? = null
    var notifyPubs:ArrayList<BhNotifyPub> = ArrayList<BhNotifyPub>()
    var notifySubs:ArrayList<BhNotifySub> = ArrayList<BhNotifySub>()
    var controlDetails:ArrayList<BhControlDto> = ArrayList<BhControlDto>()
    var childGroup:BhGroupDto? = null
}

open class BhNotifyPub
{
    var notifyType:String? = null
    var notifyEventType:String? = null
    var delay:Int? = null
}

open class BhNotifySub
{
    var notifyType:String? = null
    var notifyActionType:String? = null
}

open class BhControlDto
{
    var disabled:Boolean? = null
    var label:String? = null
    var label2:String? = null
    var name:String? = null
    var options:ArrayList<BhNameValue> = ArrayList<BhNameValue>()
    var conditionalValues:ArrayList<String> = ArrayList<String>()
    var selectGetUri:String? = null
    var validation:ArrayList<BhValidation> = ArrayList<BhValidation>()
    var notifyPubs:ArrayList<BhNotifyPub> = ArrayList<BhNotifyPub>()
    var notifySubs:ArrayList<BhNotifySub> = ArrayList<BhNotifySub>()
    var customValidation:BhCustomValidation? = null
    var placeholder:String? = null
    @SerializedName("type") var Type:String? = null
    var value:Object? = null
    var validationMessages:HashMap<String,String> = HashMap<String,String>()
    var validationPosition:String? = null
    var hideInitialValidation:Boolean? = null
    var widthClass:String? = null
    var html:String? = null
    var img:String? = null
    var imgWidth:String? = null
    var category:String? = null
    var getUri:String? = null
    var controlStyle:String? = null
    var hasSensitiveData:Boolean? = null
    var debug:Boolean? = null
    var icon:String? = null
    var mask:String? = null
    var postService:Int? = null
    var printType:String? = null
    var radioNames:ArrayList<BhNameValue> = ArrayList<BhNameValue>()
    var children:ArrayList<BhControlDto> = ArrayList<BhControlDto>()
}

open class BhNameValue
{
    var name:String? = null
    var value:String? = null
}

open class BhValidation
{
    var validationName:String? = null
    var validationLength:BigDecimal? = null
    var validationPattern:String? = null
}

open class BhCustomValidation
{
    var customFunctionName:String? = null
    var customParams:ArrayList<String> = ArrayList<String>()
}

Kotlin FormBuilderHistoryRq 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.

GET /signup/api/nat/{natID}/group/{groupId}/{usertype}/user/{userid}/formBuilderHistory/type/{FormBuilderTypeID}/info HTTP/1.1 
Host: devapi.billhighway.com 
Accept: application/json

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"form":{"templateId":0,"groups":[{"name":"String","type":"String","groupStyle":"String","debug":false,"notifyPubs":[{"notifyType":"String","notifyEventType":"String","delay":0}],"notifySubs":[{"notifyType":"String","notifyActionType":"String"}],"controlDetails":[{"disabled":false,"label":"String","label2":"String","name":"String","options":[{"name":"String","value":"String"}],"conditionalValues":["String"],"selectGetUri":"String","validation":[{"validationName":"String","validationLength":0,"validationPattern":"String"}],"notifyPubs":[{"notifyType":"String","notifyEventType":"String","delay":0}],"notifySubs":[{"notifyType":"String","notifyActionType":"String"}],"customValidation":{"customFunctionName":"String","customParams":["String"]},"placeholder":"String","type":"String","value":{},"validationMessages":{"String":"String"},"validationPosition":"String","hideInitialValidation":false,"widthClass":"String","html":"String","img":"String","imgWidth":"String","category":"String","getUri":"String","controlStyle":"String","hasSensitiveData":false,"debug":false,"icon":"String","mask":"String","postService":0,"printType":"String","radioNames":[{"name":"String","value":"String"}],"children":[{"disabled":false,"label":"String","label2":"String","name":"String","options":[{"name":"String","value":"String"}],"conditionalValues":["String"],"selectGetUri":"String","validation":[{"validationName":"String","validationLength":0,"validationPattern":"String"}],"notifyPubs":[{"notifyType":"String","notifyEventType":"String","delay":0}],"notifySubs":[{"notifyType":"String","notifyActionType":"String"}],"customValidation":{"customFunctionName":"String","customParams":["String"]},"placeholder":"String","type":"String","value":{},"validationMessages":{"String":"String"},"validationPosition":"String","hideInitialValidation":false,"widthClass":"String","html":"String","img":"String","imgWidth":"String","category":"String","getUri":"String","controlStyle":"String","hasSensitiveData":false,"debug":false,"icon":"String","mask":"String","postService":0,"printType":"String","radioNames":[{"name":"String","value":"String"}],"children":[{"disabled":false,"label":"String","label2":"String","name":"String","options":[{"name":"String","value":"String"}],"conditionalValues":["String"],"selectGetUri":"String","validation":[{"validationName":"String","validationLength":0,"validationPattern":"String"}],"notifyPubs":[{"notifyType":"String","notifyEventType":"String","delay":0}],"notifySubs":[{"notifyType":"String","notifyActionType":"String"}],"customValidation":{"customFunctionName":"String","customParams":["String"]},"placeholder":"String","type":"String","value":{},"validationMessages":{"String":"String"},"validationPosition":"String","hideInitialValidation":false,"widthClass":"String","html":"String","img":"String","imgWidth":"String","category":"String","getUri":"String","controlStyle":"String","hasSensitiveData":false,"debug":false,"icon":"String","mask":"String","postService":0,"printType":"String","radioNames":[{"name":"String","value":"String"}]}]}]}],"childGroup":{"name":"String","type":"String","groupStyle":"String","debug":false,"notifyPubs":[{"notifyType":"String","notifyEventType":"String","delay":0}],"notifySubs":[{"notifyType":"String","notifyActionType":"String"}],"controlDetails":[{"disabled":false,"label":"String","label2":"String","name":"String","options":[{"name":"String","value":"String"}],"conditionalValues":["String"],"selectGetUri":"String","validation":[{"validationName":"String","validationLength":0,"validationPattern":"String"}],"notifyPubs":[{"notifyType":"String","notifyEventType":"String","delay":0}],"notifySubs":[{"notifyType":"String","notifyActionType":"String"}],"customValidation":{"customFunctionName":"String","customParams":["String"]},"placeholder":"String","type":"String","value":{},"validationMessages":{"String":"String"},"validationPosition":"String","hideInitialValidation":false,"widthClass":"String","html":"String","img":"String","imgWidth":"String","category":"String","getUri":"String","controlStyle":"String","hasSensitiveData":false,"debug":false,"icon":"String","mask":"String","postService":0,"printType":"String","radioNames":[{"name":"String","value":"String"}],"children":[{"disabled":false,"label":"String","label2":"String","name":"String","options":[{"name":"String","value":"String"}],"conditionalValues":["String"],"selectGetUri":"String","validation":[{"validationName":"String","validationLength":0,"validationPattern":"String"}],"notifyPubs":[{"notifyType":"String","notifyEventType":"String","delay":0}],"notifySubs":[{"notifyType":"String","notifyActionType":"String"}],"customValidation":{"customFunctionName":"String","customParams":["String"]},"placeholder":"String","type":"String","value":{},"validationMessages":{"String":"String"},"validationPosition":"String","hideInitialValidation":false,"widthClass":"String","html":"String","img":"String","imgWidth":"String","category":"String","getUri":"String","controlStyle":"String","hasSensitiveData":false,"debug":false,"icon":"String","mask":"String","postService":0,"printType":"String","radioNames":[{"name":"String","value":"String"}],"children":[{"disabled":false,"label":"String","label2":"String","name":"String","options":[{"name":"String","value":"String"}],"conditionalValues":["String"],"selectGetUri":"String","validation":[{"validationName":"String","validationLength":0,"validationPattern":"String"}],"notifyPubs":[{"notifyType":"String","notifyEventType":"String","delay":0}],"notifySubs":[{"notifyType":"String","notifyActionType":"String"}],"customValidation":{"customFunctionName":"String","customParams":["String"]},"placeholder":"String","type":"String","value":{},"validationMessages":{"String":"String"},"validationPosition":"String","hideInitialValidation":false,"widthClass":"String","html":"String","img":"String","imgWidth":"String","category":"String","getUri":"String","controlStyle":"String","hasSensitiveData":false,"debug":false,"icon":"String","mask":"String","postService":0,"printType":"String","radioNames":[{"name":"String","value":"String"}]}]}]}],"childGroup":{"name":"String","type":"String","groupStyle":"String","debug":false,"notifyPubs":[{"notifyType":"String","notifyEventType":"String","delay":0}],"notifySubs":[{"notifyType":"String","notifyActionType":"String"}],"controlDetails":[{"disabled":false,"label":"String","label2":"String","name":"String","options":[{"name":"String","value":"String"}],"conditionalValues":["String"],"selectGetUri":"String","validation":[{"validationName":"String","validationLength":0,"validationPattern":"String"}],"notifyPubs":[{"notifyType":"String","notifyEventType":"String","delay":0}],"notifySubs":[{"notifyType":"String","notifyActionType":"String"}],"customValidation":{"customFunctionName":"String","customParams":["String"]},"placeholder":"String","type":"String","value":{},"validationMessages":{"String":"String"},"validationPosition":"String","hideInitialValidation":false,"widthClass":"String","html":"String","img":"String","imgWidth":"String","category":"String","getUri":"String","controlStyle":"String","hasSensitiveData":false,"debug":false,"icon":"String","mask":"String","postService":0,"printType":"String","radioNames":[{"name":"String","value":"String"}],"children":[{"disabled":false,"label":"String","label2":"String","name":"String","options":[{"name":"String","value":"String"}],"conditionalValues":["String"],"selectGetUri":"String","validation":[{"validationName":"String","validationLength":0,"validationPattern":"String"}],"notifyPubs":[{"notifyType":"String","notifyEventType":"String","delay":0}],"notifySubs":[{"notifyType":"String","notifyActionType":"String"}],"customValidation":{"customFunctionName":"String","customParams":["String"]},"placeholder":"String","type":"String","value":{},"validationMessages":{"String":"String"},"validationPosition":"String","hideInitialValidation":false,"widthClass":"String","html":"String","img":"String","imgWidth":"String","category":"String","getUri":"String","controlStyle":"String","hasSensitiveData":false,"debug":false,"icon":"String","mask":"String","postService":0,"printType":"String","radioNames":[{"name":"String","value":"String"}],"children":[{"disabled":false,"label":"String","label2":"String","name":"String","options":[{"name":"String","value":"String"}],"conditionalValues":["String"],"selectGetUri":"String","validation":[{"validationName":"String","validationLength":0,"validationPattern":"String"}],"notifyPubs":[{"notifyType":"String","notifyEventType":"String","delay":0}],"notifySubs":[{"notifyType":"String","notifyActionType":"String"}],"customValidation":{"customFunctionName":"String","customParams":["String"]},"placeholder":"String","type":"String","value":{},"validationMessages":{"String":"String"},"validationPosition":"String","hideInitialValidation":false,"widthClass":"String","html":"String","img":"String","imgWidth":"String","category":"String","getUri":"String","controlStyle":"String","hasSensitiveData":false,"debug":false,"icon":"String","mask":"String","postService":0,"printType":"String","radioNames":[{"name":"String","value":"String"}]}]}]}]}}}]}}