Forms Search Services (v2000)

Description

The collection of Quik! Forms Engine services are used to implement Quik! features and capabilities within your environment. This is a newer, and more extensive version of the v1000 version of this service.

Endpoint URL: https://websvcs.quikforms.com/rest/qfem/v2000

Endpoint Documentation: https://websvcs.quikforms.com/rest/qfem/v2000/swagger/index.html

How to Authorize on Swagger

1. Retrieve your Quik! token by calling the following service in a tool such as Postman: https://websvcs.quikforms.com/rest_authentication/token 

   1. In the body, enter the correct grant_type for your account: grant_type=password&username=YOUR_USERNAME&password=YOUR_PASSWORD

   2. Content-type should be: application/x-www-form-urlencoded

2. Copy the returned access_token value

3. In swagger, click the Authorize button, and in the value field, type Bearer, a space, and paste your token value

   1. (e.g. Bearer YOUR_TOKEN_VALUE)

4. Now you can select any method on the swagger page, click the Try it out button, enter parameters, and test the method

Notes

• The /forms/search and /forms/search/groups endpoints return search results using pagination, meaning you will need to provide PageSize (number of items per page, minimum = 5) and PageNumber (displayed results page). If not provided, default values are page size:5, page number:1. Additionally, you can reverse the Sort order by prepending a minus sign before the property you wish to sort by (i.e., -DealerName)

• The /forms/roles/client endpoint returns the list of client roles for a given form ID. This is useful when building the user interface that enables users to assign client profiles to roles on selected forms, for prefilling client information.

• The /forms/roles/sign endpoint returns the list of signer roles for a given set of form ID’s. This can be used to determine if a form or forms is intended to be sign-able and by what roles.

• The /fields/{id}/lookupvalue endpoint allows you to return values for both defined fields and user-defined fields (field names starting with "user").

• The /fields/esign endpoint allows customers to get all e-sign field metadata from Quik! for a given set of Form IDs. This data includes the following:

"Name": "string",
"DocusignXCoord": int,
"DocusignYCoord": int,
"PdfXRightCoord": int,
"PdfXLeftCoord": int,
"PdfYTopCoord": int,
"PdfYBottomCoord": int,
"FieldHeight": int,
"FieldWidth": int,
"Page": int,
"PageHeigth": int,
"PageWidth": int,
"FieldRole": "string"

Forms Data Methods

The following methods are used to obtain all the data you need to properly display form information to your users. You should update your list of forms and dealers at least once per week, if not daily. You can update any other information as often as you'd like, but probably only need to once per month.

Each of the data sets returned by the methods below correspond to a table in your database (tables are provided – see section named "Managing And Displaying Forms To Users").

• GET forms – returns a list of subscribed forms, fields, roles or groups, including the ability to search for forms

• GET dealers – returns a list of subscribed dealers and attributes

• GET categories – returns a list of form categories

• GET fields - returns a list of fields, lookup values, rules, etc. associated to one or more FormIDs

• GET states – returns a list of states used with forms

NOTE: Methods that say “QuikFormsApp_” in the name are similar or identical methods specifically used with the Quik! Forms App and should NOT be used with other implementations due to differences in authentication, security and rights associated to Quik! Forms App user accounts.