Background
Customers often have a need to generate forms for households, such that when generating bundles of forms, certain family members’ information prefills one form, and not the other. Similarly, customers often have a need to generate multiple copies of the same form in a single bundle, and prefill different people's data onto the same “role” on each copy.
Form group instances make it easier to logically separate forms according to transactions (e.g. open 3 accounts), whereas form instances are really meant to add duplicate forms into a bundle (e.g. adding extra beneficiaries).
In order to add from group instances in the same generated bundle, there is a method called AddFormIDsGroup.
...
Using Form Groups Instances in SOAP & REST
How To Specify FormIDs in Form Group Instances
When building Form Group instances with a JSON for REST or with an XML for SOAP web services, a dash ( - ) is used to separate form group instances.
Let's say you want to create a package of 3 separate groups of forms (e.g. a household with 3 accounts) using FormIDs 6996, 2 and 12. You want the paperwork for accounts A, B and C to be specified as follows:
- account A gets form IDs 6996, 2, and a second copy of Form ID 2
- account B gets Form IDs 6996 and 12
- and account C gets Form IDs 2 and 12
Thus, you would set the QuikFormID property as follows:
"QuikFormID": "6996,2,2-6996,12-2,12"
See below for sample code:
Code Block | ||||
---|---|---|---|---|
| ||||
{ "HostFormOnQuik": true, "FormFields": [ { "FieldName": "1own.FName", "FieldValue": "Stephen" }, { "FieldName": "1own.FName-1", "FieldValue": "Draymond" }, { "FieldName": "1own.FName-1000", "FieldValue": "Klay" }, { "FieldName": "1own.FName-2000", "FieldValue": "Andre" } ], "QuikFormID": "6996,2,2-6996,12-2,12" } |
...