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
namespace BH.API.DataAccess.Dto.FormBuilder

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

    [<AllowNullLiteral>]
    type FormBuilderHistoryRq() = 
        member val NatID:Int32 = new Int32() with get,set
        member val GroupId:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val FormBuilderTypeID:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val UserType:String = null with get,set
        member val UserId:String = null with get,set

    [<AllowNullLiteral>]
    type BhNotifyPub() = 
        member val notifyType:String = null with get,set
        member val notifyEventType:String = null with get,set
        member val delay:Int32 = new Int32() with get,set

    [<AllowNullLiteral>]
    type BhNotifySub() = 
        member val notifyType:String = null with get,set
        member val notifyActionType:String = null with get,set

    [<AllowNullLiteral>]
    type BhNameValue() = 
        member val name:String = null with get,set
        member val value:String = null with get,set

    [<AllowNullLiteral>]
    type BhValidation() = 
        member val validationName:String = null with get,set
        member val validationLength:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val validationPattern:String = null with get,set

    [<AllowNullLiteral>]
    type BhCustomValidation() = 
        member val customFunctionName:String = null with get,set
        member val customParams:ResizeArray<String> = new ResizeArray<String>() with get,set

    [<AllowNullLiteral>]
    type BhControlDto() = 
        member val disabled:Nullable<Boolean> = new Nullable<Boolean>() with get,set
        member val label:String = null with get,set
        member val label2:String = null with get,set
        member val name:String = null with get,set
        member val options:ResizeArray<BhNameValue> = new ResizeArray<BhNameValue>() with get,set
        member val conditionalValues:ResizeArray<String> = new ResizeArray<String>() with get,set
        member val selectGetUri:String = null with get,set
        member val validation:ResizeArray<BhValidation> = new ResizeArray<BhValidation>() with get,set
        member val notifyPubs:ResizeArray<BhNotifyPub> = new ResizeArray<BhNotifyPub>() with get,set
        member val notifySubs:ResizeArray<BhNotifySub> = new ResizeArray<BhNotifySub>() with get,set
        member val customValidation:BhCustomValidation = null with get,set
        member val placeholder:String = null with get,set
        member val type:String = null with get,set
        member val value:Object = null with get,set
        member val validationMessages:Dictionary<String, String> = new Dictionary<String, String>() with get,set
        member val validationPosition:String = null with get,set
        member val hideInitialValidation:Boolean = new Boolean() with get,set
        member val widthClass:String = null with get,set
        member val html:String = null with get,set
        member val img:String = null with get,set
        member val imgWidth:String = null with get,set
        member val category:String = null with get,set
        member val getUri:String = null with get,set
        member val controlStyle:String = null with get,set
        member val hasSensitiveData:Boolean = new Boolean() with get,set
        member val debug:Boolean = new Boolean() with get,set
        member val icon:String = null with get,set
        member val mask:String = null with get,set
        member val postService:Int32 = new Int32() with get,set
        member val printType:String = null with get,set
        member val radioNames:ResizeArray<BhNameValue> = new ResizeArray<BhNameValue>() with get,set
        member val children:ResizeArray<BhControlDto> = new ResizeArray<BhControlDto>() with get,set

    [<AllowNullLiteral>]
    type BhGroupDto() = 
        member val name:String = null with get,set
        member val type:String = null with get,set
        member val groupStyle:String = null with get,set
        member val debug:Boolean = new Boolean() with get,set
        member val notifyPubs:ResizeArray<BhNotifyPub> = new ResizeArray<BhNotifyPub>() with get,set
        member val notifySubs:ResizeArray<BhNotifySub> = new ResizeArray<BhNotifySub>() with get,set
        member val controlDetails:ResizeArray<BhControlDto> = new ResizeArray<BhControlDto>() with get,set
        member val childGroup:BhGroupDto = null with get,set

    [<AllowNullLiteral>]
    type BhFormDto() = 
        member val templateId:Int32 = new Int32() with get,set
        member val groups:ResizeArray<BhGroupDto> = new ResizeArray<BhGroupDto>() with get,set

    [<AllowNullLiteral>]
    type FormBuilderHistoryRs() = 
        member val form:BhFormDto = null with get,set

F# FormBuilderHistoryRq DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

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: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
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"}]}]}]}]}}}]}}