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
import Foundation
import ServiceStack

public class FormBuilderRq : IApiRequest, Codable
{
    public var natID:Int?
    public var groupId:Int?
    public var formBuilderTypeID:Int?
    public var userType:String?
    public var userId:String?

    required public init(){}
}

public class FormBuilderRs : IApiResponse, Codable
{
    public var form:BhFormDto?
    public var services:[BhServiceInfoDto] = []

    required public init(){}
}

public class BhFormDto : Codable
{
    public var templateId:Int?
    public var groups:[BhGroupDto] = []

    required public init(){}
}

public class BhGroupDto : Codable
{
    public var name:String?
    public var type:String?
    public var groupStyle:String?
    public var debug:Bool?
    public var notifyPubs:[BhNotifyPub] = []
    public var notifySubs:[BhNotifySub] = []
    public var controlDetails:[BhControlDto] = []
    public var childGroup:BhGroupDto?

    required public init(){}
}

public class BhNotifyPub : Codable
{
    public var notifyType:String?
    public var notifyEventType:String?
    public var delay:Int?

    required public init(){}
}

public class BhNotifySub : Codable
{
    public var notifyType:String?
    public var notifyActionType:String?

    required public init(){}
}

public class BhControlDto : Codable
{
    public var disabled:Bool?
    public var label:String?
    public var label2:String?
    public var name:String?
    public var options:[BhNameValue] = []
    public var conditionalValues:[String] = []
    public var selectGetUri:String?
    public var validation:[BhValidation] = []
    public var notifyPubs:[BhNotifyPub] = []
    public var notifySubs:[BhNotifySub] = []
    public var customValidation:BhCustomValidation?
    public var placeholder:String?
    public var type:String?
    //value:Object ignored. Type could not be extended in Swift
    public var validationMessages:[String:String] = [:]
    public var validationPosition:String?
    public var hideInitialValidation:Bool?
    public var widthClass:String?
    public var html:String?
    public var img:String?
    public var imgWidth:String?
    public var category:String?
    public var getUri:String?
    public var controlStyle:String?
    public var hasSensitiveData:Bool?
    public var debug:Bool?
    public var icon:String?
    public var mask:String?
    public var postService:Int?
    public var printType:String?
    public var radioNames:[BhNameValue] = []
    public var children:[BhControlDto] = []

    required public init(){}
}

public class BhNameValue : Codable
{
    public var name:String?
    public var value:String?

    required public init(){}
}

public class BhValidation : Codable
{
    public var validationName:String?
    public var validationLength:Double?
    public var validationPattern:String?

    required public init(){}
}

public class BhCustomValidation : Codable
{
    public var customFunctionName:String?
    public var customParams:[String] = []

    required public init(){}
}

public class BhServiceInfoDto : Codable
{
    public var serviceId:Int?
    public var serviceName:String?
    public var uri:String?
    public var serviceType:String?
    public var initFormState:Bool?
    public var serviceDetails:[BhServiceDetailInfoDto] = []

    required public init(){}
}

public class BhServiceDetailInfoDto : Codable
{
    public var serviceId:Int?
    public var name:String?
    public var mappedName:String?
    public var required:Bool?

    required public init(){}
}

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