Forms Data - Web Service

NOTE: SOAP are legacy web services originally developed for the Quik! APIs. At this time, they are deprecated and no longer in use. This guide is here for documentation purposes only.

To show a list of forms to your end users, you will need to manage a list of forms available to the user. Maintaining this list is done via the forms data web service. The web service requires user authentication information as well as dealer parameters in order to return the correct list of forms. In all valid requests, the list of forms can include any or all public dealer forms, broker/dealer forms, plus any other private dealer forms that the customer is specifically allowed to access.

Please see the QuikFormsWizard web application project with accompanying SQL Server database for a turnkey solution!

PLEASE VISIT THE URL'S BELOW FOR THE LATEST XML FORMAT

Service URL: https://websvcs.quikforms.com/qfem/v5500/formsdatawebservice.asmx
Service WSDL: https://websvcs.quikforms.com/qfem/v5500/formsdatawebservice.asmx?WSDL

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").

• GetFormsList – returns a list of subscribed forms

• GetDealerList – returns a list of subscribed dealers and attributes

• GetDealerTypes – returns a list of dealer types

• GetDealerTypeXREF – returns a list of dealers and their associated dealer types

• GetCategoryList – returns a list of form categories

• GetFormCategoryXREF – returns a list of forms and their associated categories

• GetFormStateXREF – returns a list of states each form applies to

• GetStatesList – returns a list of states used with forms

• GetFormTransTypeXREF – returns a list of forms and their assigned transaction types

• GetFormTransTypes – returns a list of transaction types that can be assigned to forms

• GetFormSignRoles – returns a list of signatory roles on a set of forms

• GetFormsListByCompanyAndShortName – returns a list of subscribed forms with Company and ShortName parameters

• GetPublicDealerList – returns a list of all public form dealers in the Quik! form library

• GetDealerListBySecurityLevel– returns a list of subscribed dealers and attributes with a security level parameter. The security level determines if a dealer is public, semi public, private or semi private.

• GetFormsListWithESignFlag – returns a list of subscribed forms and includes the attribute "IsEsignable" to know which forms have E-Sign enabled.

Form Group Methods

There are two ways to manage form groups. Using the methods below in this service you can manage form groups on your account tied to a CustomerID and a UserID. Another way to manage form groups is at the Product License level using the From Groups by License web service (Form Groups by License – Web Service).

The methods shown below work across your master account for specific UserIDs. To return the form groups you create while logged into your master account use the master account UserID in this service (which often times is your only UserID). 

• AddFormsToGroup – Adds forms to an existing form group

• AddGroup – Creates a new form group

• DeleteFormsFromGroup – Deletes forms from a form group

• DeleteGroup – Deletes a form group

• EditFormGroup – Edit form group attributes

• FormGroups – Return a list of form groups by UserID

• FormGroupsWithFormsByUserID - Return a list of form groups and the underlying forms by UserID

• FormsByGroupIDs – Return the forms within one or more form groups

• AddFormsToGroupByCustomerID – Adds forms to an existing form group, based on a given Customer ID (not userID)

• AddGroupByCustomerID – Creates a new form group, based on a given Customer ID (not userID)

• DeleteFormsFromGroupByCustomerID – Deletes forms from a form group, based on a given Customer ID (not userID)

• DeleteGroupByCustomerID – Deletes a form group, based on a given Customer ID (not userID)

• EditFormGroupByCustomerID – Edit form group attributes, based on a given Customer ID (not userID)

• FormGroupsByCustomerID – Return a list of form groups, based on a given Customer ID (not userID)

GetFormsList Details

Returns a list of the forms you have subscribed to and wish to show to your users.

SOAP Request

GetFormsList SOAP Request

SOAP Body Request Parameters

The GetFormsList method returns a list of the customer's subscribed forms. Search criteria can be used to return subsets of records for real-time end-user searches. If using these web services to perform real-time queries, then this is the last web service to call.

NOTE: This endpoint will return the first record found ordered by publish date. If a form exists in both FINAL and PUBLISH statuses in the Quik! system, then only the PUBLISH version will be returned. If there's a form only in FINAL status (not yet published), that record will be returned.

SOAP Response

GetFormsList SOAP Response

Result Fields

The GetFormsList method returns a list of the customer's subscribed forms. Search criteria can be used to return subsets of records for real-time end-user searches. If using these web services to perform real-time queries, then this is the last web service to call.

GetDealerList Details

Returns a list of dealers and their attributes based on the forms that you have subscribed to. This information is helpful for displaying a form's dealer (company) name.

SOAP Request

GetDealerList SOAP Request

SOAP Body Request Parameters

The GetDealerList method returns a list of the customer's subscribed dealers and attributes.

SOAP Response

GetDealerList SOAP Response

Result Fields

GetDealerTypes Details

Returns a list of dealer types that apply to the companies that provide forms. Dealer types include Insurance, Annuity, Broker/Dealer, Clearing House, etc.

SOAP Request

GetDealerTypes SOAP Request

SOAP Body Request Parameters

The GetDealerTypes method returns a list of dealer types for use when selecting dealers.

SOAP Response

GetDealerTypes SOAP Response

Result Fields

GetDealerTypeXREF Details

The GetDealerTypeXREF method returns a list of dealers and their associated dealer types.

SOAP Request

GetDealerTypeXREF SOAP Request

SOAP Body Request Parameters

To limit the results of this web service pass in DealerIDs and/or DealerTypeIDs.

SOAP Response

GetDealerTypeXREF SOAP Response

Result Fields

GetCategoryList Details

Returns a list of form categories. A form category is defined within Quik! to better organize the form along a line of business or type of transaction (e.g. Mutual Funds, Insurance, Annuity, College Planning, Retirement, etc.).

SOAP Request

GetCategoryList SOAP Request

SOAP Body Request Parameters

The GetCategoryList method returns a list of form categories for use when selecting dealers and forms.