| 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 |
export class FormBuilderRq implements IApiRequest
{
public NatID?: number;
public GroupId?: number;
public FormBuilderTypeID?: number;
public UserType?: string;
public UserId?: string;
public constructor(init?: Partial<FormBuilderRq>) { (Object as any).assign(this, init); }
}
export class BhNotifyPub
{
public notifyType?: string;
public notifyEventType?: string;
public delay?: number;
public constructor(init?: Partial<BhNotifyPub>) { (Object as any).assign(this, init); }
}
export class BhNotifySub
{
public notifyType?: string;
public notifyActionType?: string;
public constructor(init?: Partial<BhNotifySub>) { (Object as any).assign(this, init); }
}
export class BhNameValue
{
public name?: string;
public value?: string;
public constructor(init?: Partial<BhNameValue>) { (Object as any).assign(this, init); }
}
export class BhValidation
{
public validationName?: string;
public validationLength?: number;
public validationPattern?: string;
public constructor(init?: Partial<BhValidation>) { (Object as any).assign(this, init); }
}
export class BhCustomValidation
{
public customFunctionName?: string;
public customParams?: string[];
public constructor(init?: Partial<BhCustomValidation>) { (Object as any).assign(this, init); }
}
export class BhControlDto
{
public disabled?: boolean;
public label?: string;
public label2?: string;
public name?: string;
public options?: BhNameValue[];
public conditionalValues?: string[];
public selectGetUri?: string;
public validation?: BhValidation[];
public notifyPubs?: BhNotifyPub[];
public notifySubs?: BhNotifySub[];
public customValidation?: BhCustomValidation;
public placeholder?: string;
public type?: string;
public value?: Object;
public validationMessages?: { [index: string]: string; };
public validationPosition?: string;
public hideInitialValidation?: boolean;
public widthClass?: string;
public html?: string;
public img?: string;
public imgWidth?: string;
public category?: string;
public getUri?: string;
public controlStyle?: string;
public hasSensitiveData?: boolean;
public debug?: boolean;
public icon?: string;
public mask?: string;
public postService?: number;
public printType?: string;
public radioNames?: BhNameValue[];
public children?: BhControlDto[];
public constructor(init?: Partial<BhControlDto>) { (Object as any).assign(this, init); }
}
export class BhGroupDto
{
public name?: string;
public type?: string;
public groupStyle?: string;
public debug?: boolean;
public notifyPubs?: BhNotifyPub[];
public notifySubs?: BhNotifySub[];
public controlDetails?: BhControlDto[];
public childGroup?: BhGroupDto;
public constructor(init?: Partial<BhGroupDto>) { (Object as any).assign(this, init); }
}
export class BhFormDto
{
public templateId?: number;
public groups?: BhGroupDto[];
public constructor(init?: Partial<BhFormDto>) { (Object as any).assign(this, init); }
}
export class BhServiceDetailInfoDto
{
public serviceId?: number;
public name?: string;
public mappedName?: string;
public required?: boolean;
public constructor(init?: Partial<BhServiceDetailInfoDto>) { (Object as any).assign(this, init); }
}
export class BhServiceInfoDto
{
public serviceId?: number;
public serviceName?: string;
public uri?: string;
public serviceType?: string;
public initFormState?: boolean;
public serviceDetails?: BhServiceDetailInfoDto[];
public constructor(init?: Partial<BhServiceInfoDto>) { (Object as any).assign(this, init); }
}
export class FormBuilderRs implements IApiResponse
{
public form?: BhFormDto;
public services?: BhServiceInfoDto[];
public constructor(init?: Partial<FormBuilderRs>) { (Object as any).assign(this, init); }
}
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
}
]
}
]
}