Forms Search Services (v1000) - LEGACY

Description

The collection of Quik! Forms Enterprise Manager services are used to implement Quik! features and capabilities within your environment. For example, you may need to retrieve and display a list of forms to users, or register users and licenses, or to perform field mapping. This service contains methods to access field information about a specific form. The intent of this service is to make it easier to identify fields on a given FormID (the Quik! form identifier) for use with field mapping or validating information on a form, etc.

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

Endpoint Documentation: https://websvcs.quikforms.com/rest/qfem/v1000/swagger

Services

Service

URL

Type

Service Description

Parameters

Field List by Form ID

/forms/fields

POST

This method takes in a list of FormIDs (CSV format) and returns all of the fields for those forms. It is recommended that you keep the list of FormIDs short as the more IDs you include at once the bigger the response will become and the longer it will take to return the results.

Form ID (Integer, comma separated)

Field Lookup Values By FieldID

/fields/lookupvalue/{fieldid}

GET

This method takes in a FieldID returned by the Field List service (above) and returns any lookup values associated to the field. For example, if the field is for the "Male" gender checkbox on the form then the lookup value should return a 1 for male.

Field ID (Integer)

Field List by Rules for CustomerID and Form ID

/fields/fieldrules

POST

Returns a list of fields that have rules applied by CustomerID and FormIDs

CustomerID (Either the CustomerID of the Authenticating Credentials or a SubCustomer associated to it.)

Form ID (Fields belonging to these forms will be returned)

AttributeTypeID (OPTIONAL- List of AttributeTypeIDs. If provided, only fields with rules of the given types will be returned)

TestMode (OPTIONAL- If true, rules in Test mode will be returned as well. If false, only active rules will be retrieved.)

Sample Project

A sample project in C# was built for testing this API. You can download the project and use it as an example for your development. DOWNLOAD HERE