Form Groups Services

Description

The collection of Form Groups services are used to manage and create Form Groups in a customer account.

Endpoint URL: https://websvcs.quikforms.com/rest/formgroups/v1000/

Endpoint Documentation (Swagger - Production): https://websvcs.quikforms.com/rest/formgroups/v1000/swagger/index.html

Endpoint Documentation (Swagger - UAT): https://uatwebsvcs.quikforms.com/rest/formgroups/v1000/swagger/index.html

Notes

All methods listed in the FormGroups section of the above swagger page are intended for managing Form Groups based on a Quik! licenses. As the vast majority of Quik! customers manage Form Groups based on Customer ID (not licenses), only the FormGroupsByCustomer methods are documented below. Contact Quik! if you need more information on managing Form Groups based on licenses.
This API can only be called using Master Quik! credentials for a customer account (not regular user credentials)

Methods

FormGroupsByCustomer

Method	URL	TYPE	Parameters

Method	URL	TYPE	Parameters
Create Form Group	/customers/formgroups	POST	`"Name"` (string): The name of the Form Group `"Description"` (string): The description of the Form Group `"FormIds"` (int array): An array of Form ID(s) to be included in the Form Group `"IsPublic"` (boolean): When TRUE, Form Group is available to all users in customer account Sample body: { "Name": "my group", "Description": "", "FormIds": [1,2,12,], "IsPublic": true }
Get Form Groups	/customers/formgroups	GET	No parameters. Returns a list of all Form Groups that belong to a customer account
Get Form Group by ID	/customers/formgroups/{id}	GET	`{id}` (int): The Form Group ID to be retrieved. This Form Group ID must be entered at the end of the URL when calling this API
Delete Form Group by ID	/customers/formgroups/{id}	DELETE	`{id}` (int): The Form Group ID to be deleted. This Form Group ID must be entered at the end of the URL when calling this API
Edit Form Group by ID	/customers/formgroups/{id}	PUT	`{id}` (int): The Form Group ID to be edited. This Form Group ID must be entered at the end of the URL when calling this API `"Name"` (string): Edit the name of the Form Group `"Description"` (string): Edit the description of the Form Group `"IsPublic"` (boolean): Edit whether the Form Group is available to all users in customer account Sample body: { "Name": "new group name", "IsPublic": false }
Add Form IDs to Form Group	/customers/formgroups/{id}/forms	POST	`{id}` (int): The Form Group ID to be edited. This Form Group ID must be entered at the end of the URL when calling this API `Request body:` An array of Form ID(s) to be added to the Form Group. Sample body: [1,2]
Delete Form IDs from Form Group	/customers/formgroups/{id}/forms	DELETE	`{id}` (int): The Form Group ID to be edited. This Form Group ID must be entered at the end of the URL when calling this API `Request body:` (int array): An array of Form ID(s) to be removed from the Form Group Sample body: [1,2]