| 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 java.math.*;
import java.util.*;
import net.servicestack.client.*;
public class dtos
{
public static class FormBuilderRq implements IApiRequest
{
public Integer NatID = null;
public Integer GroupId = null;
public Integer FormBuilderTypeID = null;
public String UserType = null;
public String UserId = null;
public Integer getNatID() { return NatID; }
public FormBuilderRq setNatID(Integer value) { this.NatID = value; return this; }
public Integer getGroupId() { return GroupId; }
public FormBuilderRq setGroupId(Integer value) { this.GroupId = value; return this; }
public Integer getFormBuilderTypeID() { return FormBuilderTypeID; }
public FormBuilderRq setFormBuilderTypeID(Integer value) { this.FormBuilderTypeID = value; return this; }
public String getUserType() { return UserType; }
public FormBuilderRq setUserType(String value) { this.UserType = value; return this; }
public String getUserId() { return UserId; }
public FormBuilderRq setUserId(String value) { this.UserId = value; return this; }
}
public static class FormBuilderRs implements IApiResponse
{
public BhFormDto form = null;
public ArrayList<BhServiceInfoDto> services = null;
public BhFormDto getForm() { return form; }
public FormBuilderRs setForm(BhFormDto value) { this.form = value; return this; }
public ArrayList<BhServiceInfoDto> getServices() { return services; }
public FormBuilderRs setServices(ArrayList<BhServiceInfoDto> value) { this.services = value; return this; }
}
public static class BhFormDto
{
public Integer templateId = null;
public ArrayList<BhGroupDto> groups = null;
public Integer getTemplateId() { return templateId; }
public BhFormDto setTemplateId(Integer value) { this.templateId = value; return this; }
public ArrayList<BhGroupDto> getGroups() { return groups; }
public BhFormDto setGroups(ArrayList<BhGroupDto> value) { this.groups = value; return this; }
}
public static class BhGroupDto
{
public String name = null;
public String type = null;
public String groupStyle = null;
public Boolean debug = null;
public ArrayList<BhNotifyPub> notifyPubs = null;
public ArrayList<BhNotifySub> notifySubs = null;
public ArrayList<BhControlDto> controlDetails = null;
public BhGroupDto childGroup = null;
public String getName() { return name; }
public BhGroupDto setName(String value) { this.name = value; return this; }
public String getType() { return type; }
public BhGroupDto setType(String value) { this.type = value; return this; }
public String getGroupStyle() { return groupStyle; }
public BhGroupDto setGroupStyle(String value) { this.groupStyle = value; return this; }
public Boolean isDebug() { return debug; }
public BhGroupDto setDebug(Boolean value) { this.debug = value; return this; }
public ArrayList<BhNotifyPub> getNotifyPubs() { return notifyPubs; }
public BhGroupDto setNotifyPubs(ArrayList<BhNotifyPub> value) { this.notifyPubs = value; return this; }
public ArrayList<BhNotifySub> getNotifySubs() { return notifySubs; }
public BhGroupDto setNotifySubs(ArrayList<BhNotifySub> value) { this.notifySubs = value; return this; }
public ArrayList<BhControlDto> getControlDetails() { return controlDetails; }
public BhGroupDto setControlDetails(ArrayList<BhControlDto> value) { this.controlDetails = value; return this; }
public BhGroupDto getChildGroup() { return childGroup; }
public BhGroupDto setChildGroup(BhGroupDto value) { this.childGroup = value; return this; }
}
public static class BhNotifyPub
{
public String notifyType = null;
public String notifyEventType = null;
public Integer delay = null;
public String getNotifyType() { return notifyType; }
public BhNotifyPub setNotifyType(String value) { this.notifyType = value; return this; }
public String getNotifyEventType() { return notifyEventType; }
public BhNotifyPub setNotifyEventType(String value) { this.notifyEventType = value; return this; }
public Integer getDelay() { return delay; }
public BhNotifyPub setDelay(Integer value) { this.delay = value; return this; }
}
public static class BhNotifySub
{
public String notifyType = null;
public String notifyActionType = null;
public String getNotifyType() { return notifyType; }
public BhNotifySub setNotifyType(String value) { this.notifyType = value; return this; }
public String getNotifyActionType() { return notifyActionType; }
public BhNotifySub setNotifyActionType(String value) { this.notifyActionType = value; return this; }
}
public static class BhControlDto
{
public Boolean disabled = null;
public String label = null;
public String label2 = null;
public String name = null;
public ArrayList<BhNameValue> options = null;
public ArrayList<String> conditionalValues = null;
public String selectGetUri = null;
public ArrayList<BhValidation> validation = null;
public ArrayList<BhNotifyPub> notifyPubs = null;
public ArrayList<BhNotifySub> notifySubs = null;
public BhCustomValidation customValidation = null;
public String placeholder = null;
public String type = null;
public Object value = null;
public HashMap<String,String> validationMessages = null;
public String validationPosition = null;
public Boolean hideInitialValidation = null;
public String widthClass = null;
public String html = null;
public String img = null;
public String imgWidth = null;
public String category = null;
public String getUri = null;
public String controlStyle = null;
public Boolean hasSensitiveData = null;
public Boolean debug = null;
public String icon = null;
public String mask = null;
public Integer postService = null;
public String printType = null;
public ArrayList<BhNameValue> radioNames = null;
public ArrayList<BhControlDto> children = null;
public Boolean isDisabled() { return disabled; }
public BhControlDto setDisabled(Boolean value) { this.disabled = value; return this; }
public String getLabel() { return label; }
public BhControlDto setLabel(String value) { this.label = value; return this; }
public String getLabel2() { return label2; }
public BhControlDto setLabel2(String value) { this.label2 = value; return this; }
public String getName() { return name; }
public BhControlDto setName(String value) { this.name = value; return this; }
public ArrayList<BhNameValue> getOptions() { return options; }
public BhControlDto setOptions(ArrayList<BhNameValue> value) { this.options = value; return this; }
public ArrayList<String> getConditionalValues() { return conditionalValues; }
public BhControlDto setConditionalValues(ArrayList<String> value) { this.conditionalValues = value; return this; }
public String getSelectGetUri() { return selectGetUri; }
public BhControlDto setSelectGetUri(String value) { this.selectGetUri = value; return this; }
public ArrayList<BhValidation> getValidation() { return validation; }
public BhControlDto setValidation(ArrayList<BhValidation> value) { this.validation = value; return this; }
public ArrayList<BhNotifyPub> getNotifyPubs() { return notifyPubs; }
public BhControlDto setNotifyPubs(ArrayList<BhNotifyPub> value) { this.notifyPubs = value; return this; }
public ArrayList<BhNotifySub> getNotifySubs() { return notifySubs; }
public BhControlDto setNotifySubs(ArrayList<BhNotifySub> value) { this.notifySubs = value; return this; }
public BhCustomValidation getCustomValidation() { return customValidation; }
public BhControlDto setCustomValidation(BhCustomValidation value) { this.customValidation = value; return this; }
public String getPlaceholder() { return placeholder; }
public BhControlDto setPlaceholder(String value) { this.placeholder = value; return this; }
public String getType() { return type; }
public BhControlDto setType(String value) { this.type = value; return this; }
public Object getValue() { return value; }
public BhControlDto setValue(Object value) { this.value = value; return this; }
public HashMap<String,String> getValidationMessages() { return validationMessages; }
public BhControlDto setValidationMessages(HashMap<String,String> value) { this.validationMessages = value; return this; }
public String getValidationPosition() { return validationPosition; }
public BhControlDto setValidationPosition(String value) { this.validationPosition = value; return this; }
public Boolean isHideInitialValidation() { return hideInitialValidation; }
public BhControlDto setHideInitialValidation(Boolean value) { this.hideInitialValidation = value; return this; }
public String getWidthClass() { return widthClass; }
public BhControlDto setWidthClass(String value) { this.widthClass = value; return this; }
public String getHtml() { return html; }
public BhControlDto setHtml(String value) { this.html = value; return this; }
public String getImg() { return img; }
public BhControlDto setImg(String value) { this.img = value; return this; }
public String getImgWidth() { return imgWidth; }
public BhControlDto setImgWidth(String value) { this.imgWidth = value; return this; }
public String getCategory() { return category; }
public BhControlDto setCategory(String value) { this.category = value; return this; }
public String getGetUri() { return getUri; }
public BhControlDto setGetUri(String value) { this.getUri = value; return this; }
public String getControlStyle() { return controlStyle; }
public BhControlDto setControlStyle(String value) { this.controlStyle = value; return this; }
public Boolean isHasSensitiveData() { return hasSensitiveData; }
public BhControlDto setHasSensitiveData(Boolean value) { this.hasSensitiveData = value; return this; }
public Boolean isDebug() { return debug; }
public BhControlDto setDebug(Boolean value) { this.debug = value; return this; }
public String getIcon() { return icon; }
public BhControlDto setIcon(String value) { this.icon = value; return this; }
public String getMask() { return mask; }
public BhControlDto setMask(String value) { this.mask = value; return this; }
public Integer getPostService() { return postService; }
public BhControlDto setPostService(Integer value) { this.postService = value; return this; }
public String getPrintType() { return printType; }
public BhControlDto setPrintType(String value) { this.printType = value; return this; }
public ArrayList<BhNameValue> getRadioNames() { return radioNames; }
public BhControlDto setRadioNames(ArrayList<BhNameValue> value) { this.radioNames = value; return this; }
public ArrayList<BhControlDto> getChildren() { return children; }
public BhControlDto setChildren(ArrayList<BhControlDto> value) { this.children = value; return this; }
}
public static class BhNameValue
{
public String name = null;
public String value = null;
public String getName() { return name; }
public BhNameValue setName(String value) { this.name = value; return this; }
public String getValue() { return value; }
public BhNameValue setValue(String value) { this.value = value; return this; }
}
public static class BhValidation
{
public String validationName = null;
public BigDecimal validationLength = null;
public String validationPattern = null;
public String getValidationName() { return validationName; }
public BhValidation setValidationName(String value) { this.validationName = value; return this; }
public BigDecimal getValidationLength() { return validationLength; }
public BhValidation setValidationLength(BigDecimal value) { this.validationLength = value; return this; }
public String getValidationPattern() { return validationPattern; }
public BhValidation setValidationPattern(String value) { this.validationPattern = value; return this; }
}
public static class BhCustomValidation
{
public String customFunctionName = null;
public ArrayList<String> customParams = null;
public String getCustomFunctionName() { return customFunctionName; }
public BhCustomValidation setCustomFunctionName(String value) { this.customFunctionName = value; return this; }
public ArrayList<String> getCustomParams() { return customParams; }
public BhCustomValidation setCustomParams(ArrayList<String> value) { this.customParams = value; return this; }
}
public static class BhServiceInfoDto
{
public Integer serviceId = null;
public String serviceName = null;
public String uri = null;
public String serviceType = null;
public Boolean initFormState = null;
public ArrayList<BhServiceDetailInfoDto> serviceDetails = null;
public Integer getServiceId() { return serviceId; }
public BhServiceInfoDto setServiceId(Integer value) { this.serviceId = value; return this; }
public String getServiceName() { return serviceName; }
public BhServiceInfoDto setServiceName(String value) { this.serviceName = value; return this; }
public String getUri() { return uri; }
public BhServiceInfoDto setUri(String value) { this.uri = value; return this; }
public String getServiceType() { return serviceType; }
public BhServiceInfoDto setServiceType(String value) { this.serviceType = value; return this; }
public Boolean isInitFormState() { return initFormState; }
public BhServiceInfoDto setInitFormState(Boolean value) { this.initFormState = value; return this; }
public ArrayList<BhServiceDetailInfoDto> getServiceDetails() { return serviceDetails; }
public BhServiceInfoDto setServiceDetails(ArrayList<BhServiceDetailInfoDto> value) { this.serviceDetails = value; return this; }
}
public static class BhServiceDetailInfoDto
{
public Integer serviceId = null;
public String name = null;
public String mappedName = null;
public Boolean required = null;
public Integer getServiceId() { return serviceId; }
public BhServiceDetailInfoDto setServiceId(Integer value) { this.serviceId = value; return this; }
public String getName() { return name; }
public BhServiceDetailInfoDto setName(String value) { this.name = value; return this; }
public String getMappedName() { return mappedName; }
public BhServiceDetailInfoDto setMappedName(String value) { this.mappedName = value; return this; }
public Boolean isRequired() { return required; }
public BhServiceDetailInfoDto setRequired(Boolean value) { this.required = value; return this; }
}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
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/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
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
}
]
}
]
}