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 CLICK ON THE URL'S BELOW TO SEE THE EXACT XML FORMAT OF EACH SERVICE
Production URL: https://websvcs.quikforms.com/qfem/v5200/formsdatawebservice.asmx
WSDL: https://websvcs.quikforms.com/qfem/v5200/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

GetFormsList Details

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

SOAP Request

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://www.w3.org/2003/05/soap-envelope">
<soap12:Header>
<AuthenticationHeader xmlns="https://websvcs.quikforms.com/QFEM/v5000/">
<CustomerID>string</CustomerID>
<UserName>string</UserName>
<Password>string</Password>
</AuthenticationHeader>
</soap12:Header>
<soap12:Body>
<GetFormsList xmlns="https://websvcs.quikforms.com/QFEM/v5000/">
<FormIDList>string</FormIDList>
<DealerIDList>string</DealerIDList>
<DealerName>string</DealerName>
<FormCategoryIDList>string</FormCategoryIDList>
<FormShortName>string</FormShortName>
<FormStatusIDList>string</FormStatusIDList>
<PublishDateFrom>dateTime</PublishDateFrom>
<PublishDateTo>dateTime</PublishDateTo>
<LitNo>string</LitNo>
<DealerTypeIDList>string</DealerTypeIDList>
<DealerStatusIDList>string</DealerStatusIDList>
<StateIDList>string</StateIDList>
<FormTransTypeIDList>string</FormTransTypeIDList>
</GetFormsList>
</soap12:Body>
</soap12:Envelope>

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.

SOAP Response

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<GetFormsListResponse xmlns="https://websvcs.quikforms.com/QFEM/v5000/">
<GetFormsListResult>
<ErrorCode>int</ErrorCode>
<Message>string</Message>
<ResultData>
<xsd:schema>schema</xsd:schema>xml</ResultData>
<File>base64Binary</File>
</GetFormsListResult>
</GetFormsListResponse>
</soap12:Body>
</soap12:Envelope>

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

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://www.w3.org/2003/05/soap-envelope">
<soap12:Header>
<AuthenticationHeader xmlns="https://websvcs.quikforms.com/QFEM/v5000/">
<CustomerID>string</CustomerID>
<UserName>string</UserName>
<Password>string</Password>
</AuthenticationHeader>
</soap12:Header>
<soap12:Body>
<GetDealerList xmlns="https://websvcs.quikforms.com/QFEM/v5000/">
<DealerIDList>string</DealerIDList>
<DealerName>string</DealerName>
<DealerStatusIDList>string</DealerStatusIDList>
</GetDealerList>
</soap12:Body>
</soap12:Envelope>

SOAP Body Request Parameters

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

SOAP Response

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<GetDealerListResponse xmlns="https://websvcs.quikforms.com/QFEM/v5000/">
<GetDealerListResult>
<ErrorCode>int</ErrorCode>
<Message>string</Message>
<ResultData>
<xsd:schema>schema</xsd:schema>xml</ResultData>
<File>base64Binary</File>
</GetDealerListResult>
</GetDealerListResponse>
</soap12:Body>
</soap12:Envelope>

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

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://www.w3.org/2003/05/soap-envelope">
<soap12:Header>
<AuthenticationHeader xmlns="https://websvcs.quikforms.com/QFEM/v5000/">
<CustomerID>string</CustomerID>
<UserName>string</UserName>
<Password>string</Password>
</AuthenticationHeader>
</soap12:Header>
<soap12:Body>
<GetDealerTypes xmlns="https://websvcs.quikforms.com/QFEM/v5000/">
<DealerTypeIDList>string</DealerTypeIDList>
</GetDealerTypes>
</soap12:Body>
</soap12:Envelope>

SOAP Body Request Parameters

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

SOAP Response

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<GetDealerTypesResponse xmlns="https://websvcs.quikforms.com/QFEM/v5000/">
<GetDealerTypesResult>
<ErrorCode>int</ErrorCode>
<Message>string</Message>
<ResultData>
<xsd:schema>schema</xsd:schema>xml</ResultData>
<File>base64Binary</File>
</GetDealerTypesResult>
</GetDealerTypesResponse>
</soap12:Body>
</soap12:Envelope>

Result Fields