Billhighway Cloud API

<back to all web services

FormBuilderRq

The following routes are available for this service:
GET/signup/api/nat/{natID}/group/{groupId}/formBuilder/type/{FormBuilderTypeID}/info
GET/signup/api/nat/{natID}/group/{groupId}/{usertype}/user/{userid}/formBuilder/type/{FormBuilderTypeID}/info
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports BH.CloudAPI.Common4.DTO.FormBuilder.Request
Imports BH.CloudAPI.Common4.DTO.FormBuilder.Response
Imports BH.API.DataAccess.Dto.FormBuilder

Namespace Global

    Namespace BH.API.DataAccess.Dto.FormBuilder

        Public Partial Class BhControlDto
            Public Sub New()
                options = New List(Of BhNameValue)
                conditionalValues = New List(Of String)
                validation = New List(Of BhValidation)
                notifyPubs = New List(Of BhNotifyPub)
                notifySubs = New List(Of BhNotifySub)
                validationMessages = New Dictionary(Of String, String)
                radioNames = New List(Of BhNameValue)
                children = New List(Of BhControlDto)
            End Sub

            Public Overridable Property disabled As Nullable(Of Boolean)
            Public Overridable Property label As String
            Public Overridable Property label2 As String
            Public Overridable Property name As String
            Public Overridable Property options As List(Of BhNameValue)
            Public Overridable Property conditionalValues As List(Of String)
            Public Overridable Property selectGetUri As String
            Public Overridable Property validation As List(Of BhValidation)
            Public Overridable Property notifyPubs As List(Of BhNotifyPub)
            Public Overridable Property notifySubs As List(Of BhNotifySub)
            Public Overridable Property customValidation As BhCustomValidation
            Public Overridable Property placeholder As String
            Public Overridable Property type As String
            Public Overridable Property value As Object
            Public Overridable Property validationMessages As Dictionary(Of String, String)
            Public Overridable Property validationPosition As String
            Public Overridable Property hideInitialValidation As Boolean
            Public Overridable Property widthClass As String
            Public Overridable Property html As String
            Public Overridable Property img As String
            Public Overridable Property imgWidth As String
            Public Overridable Property category As String
            Public Overridable Property getUri As String
            Public Overridable Property controlStyle As String
            Public Overridable Property hasSensitiveData As Boolean
            Public Overridable Property debug As Boolean
            Public Overridable Property icon As String
            Public Overridable Property mask As String
            Public Overridable Property postService As Integer
            Public Overridable Property printType As String
            Public Overridable Property radioNames As List(Of BhNameValue)
            Public Overridable Property children As List(Of BhControlDto)
        End Class

        Public Partial Class BhCustomValidation
            Public Sub New()
                customParams = New List(Of String)
            End Sub

            Public Overridable Property customFunctionName As String
            Public Overridable Property customParams As List(Of String)
        End Class

        Public Partial Class BhFormDto
            Public Sub New()
                groups = New List(Of BhGroupDto)
            End Sub

            Public Overridable Property templateId As Integer
            Public Overridable Property groups As List(Of BhGroupDto)
        End Class

        Public Partial Class BhGroupDto
            Public Sub New()
                notifyPubs = New List(Of BhNotifyPub)
                notifySubs = New List(Of BhNotifySub)
                controlDetails = New List(Of BhControlDto)
            End Sub

            Public Overridable Property name As String
            Public Overridable Property type As String
            Public Overridable Property groupStyle As String
            Public Overridable Property debug As Boolean
            Public Overridable Property notifyPubs As List(Of BhNotifyPub)
            Public Overridable Property notifySubs As List(Of BhNotifySub)
            Public Overridable Property controlDetails As List(Of BhControlDto)
            Public Overridable Property childGroup As BhGroupDto
        End Class

        Public Partial Class BhNameValue
            Public Overridable Property name As String
            Public Overridable Property value As String
        End Class

        Public Partial Class BhNotifyPub
            Public Overridable Property notifyType As String
            Public Overridable Property notifyEventType As String
            Public Overridable Property delay As Integer
        End Class

        Public Partial Class BhNotifySub
            Public Overridable Property notifyType As String
            Public Overridable Property notifyActionType As String
        End Class

        Public Partial Class BhServiceDetailInfoDto
            Public Overridable Property serviceId As Integer
            Public Overridable Property name As String
            Public Overridable Property mappedName As String
            Public Overridable Property required As Boolean
        End Class

        Public Partial Class BhServiceInfoDto
            Public Sub New()
                serviceDetails = New List(Of BhServiceDetailInfoDto)
            End Sub

            Public Overridable Property serviceId As Integer
            Public Overridable Property serviceName As String
            Public Overridable Property uri As String
            Public Overridable Property serviceType As String
            Public Overridable Property initFormState As Boolean
            Public Overridable Property serviceDetails As List(Of BhServiceDetailInfoDto)
        End Class

        Public Partial Class BhValidation
            Public Overridable Property validationName As String
            Public Overridable Property validationLength As Nullable(Of Decimal)
            Public Overridable Property validationPattern As String
        End Class
    End Namespace

    Namespace BH.CloudAPI.Common4.DTO.FormBuilder.Request

        Public Partial Class FormBuilderRq
            Implements IApiRequest
            Public Overridable Property NatID As Integer
            Public Overridable Property GroupId As Nullable(Of Integer)
            Public Overridable Property FormBuilderTypeID As Nullable(Of Integer)
            Public Overridable Property UserType As String
            Public Overridable Property UserId As String
        End Class
    End Namespace

    Namespace BH.CloudAPI.Common4.DTO.FormBuilder.Response

        Public Partial Class FormBuilderRs
            Implements IApiResponse
            Public Sub New()
                services = New List(Of BhServiceInfoDto)
            End Sub

            Public Overridable Property form As BhFormDto
            Public Overridable Property services As List(Of BhServiceInfoDto)
        End Class
    End Namespace
End Namespace

VB.NET FormBuilderRq 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}/formBuilder/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"}]}]}]}]}}}]},"services":[{"serviceId":0,"serviceName":"String","uri":"String","serviceType":"String","initFormState":false,"serviceDetails":[{"serviceId":0,"name":"String","mappedName":"String","required":false}]}]}