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.

Field Name	Data Type	Length	Required?	Description
FormIDList	String	8000 chars	NO	CSV list of unique form IDs
DealerIDList	String	8000 chars	NO	CSV list of unique dealer IDs
DealerName	String	1000 chars	NO	Quik! dealer company name
FormCategoryIDList	String	8000 chars	NO	CSV list of form category IDs
FormShortName	String	250 chars	NO	Short descriptive name of the form
FormStatusIDList	String	8000 chars	NO	CSV list of form status IDs
PublishDateFROM	Date		NO	The minimum date form was published to Quik! users
PublishDateTO	Date		NO	The maximum date form was published to Quik! users
LitNo	String	100 chars	NO	Literature number of the form, as provided by the dealer
DealerTypeIDList	String	8000 chars	NO	CSV list of dealer type IDs
DealerStatusIDList	String	8000 chars	NO	CSV list of dealer status IDs
StateIDList	String	8000 chars	NO	CSV list of state IDs
FormTransTypeIDList	String	8000 chars	NO	CSV list of transaction type IDs

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.

Field Name	Data Type	Length	Description
FormID	Integer		Quik! unique form ID
DealerID	Integer		Quik! unique dealer ID
DealerName	String	1000 chars	Quik! dealer company name
FormShortName	String	250 chars	Short descriptive name of the form
FormDesc	String	1000 chars	Long description of the form
FormStatusID	Integer		Form status (1 = active / 2 = inactive)
PublishDate	Date		Date form was published to Quik! users
FileSize	Integer		File size of form's PDF file in bytes
LitNo	String	100 chars	Literature number of the form, as provided by the dealer
NoPages	Integer		Number of pages in the form's PDF file
DealerStatus	String	255 chars	Dealer status description

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.

Field Name	Data Type	Length	Required?	Description
DealerIDList	String	8000 chars	NO	CSV list of unique dealer IDs
DealerName	String	1000 chars	No	Quik! dealer name (form company)
DealerStatusIDList	String	8000 chars	NO	CSV list of dealer status IDs

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

Field Name	Data Type	Length	Description
DealerID	Integer		Quik! dealer unique ID
DealerName	String	1000 chars	Quik! dealer name (form company)
DealerStatusID	Integer		Dealer status unique ID
DealerStatus	String	255 chars	Dealer status description

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.

Field Name	Data Type	Length	Required?	Description
DealerTypeIDList	String	8000 chars	NO	CSV list of dealer type IDs

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

Field Name	Data Type	Length	Description
DealerTypeID	Integer		Dealer type unique ID
DealerType	String	255 chars	Dealer type
DealerTypeDesc	String	255 chars	Dealer type description

GetDealerTypeXREF Details

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

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>
<GetDealerTypeXREF xmlns="https://websvcs.quikforms.com/QFEM/v5000/">
<DealerIDList>string</DealerIDList>
<DealerTypeIDList>string</DealerTypeIDList>
</GetDealerTypeXREF>
</soap12:Body>
</soap12:Envelope>

SOAP Body Request Parameters

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

Field Name	Data Type	Length	Required?	Description
DealerIDList	String	8000 chars	NO	CSV list of unique dealer IDs
DealerTypeIDList	String	8000 chars	NO	CSV list of dealer type IDs

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>
<GetDealerTypeXREFResponse xmlns="https://websvcs.quikforms.com/QFEM/v5000/">
<GetDealerTypeXREFResult>
<ErrorCode>int</ErrorCode>
<Message>string</Message>
<ResultData>
<xsd:schema>schema</xsd:schema>xml</ResultData>
<File>base64Binary</File>
</GetDealerTypeXREFResult>
</GetDealerTypeXREFResponse>
</soap12:Body>
</soap12:Envelope>

Result Fields

Field Name	Data Type	Length	Description
DealerID	Integer		Quik! dealer unique ID
DealerTypeID	Integer		Dealer type unique ID

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

<?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>
<GetCategoryList xmlns="https://websvcs.quikforms.com/QFEM/v5000/">
<FormCategoryIDList>string</FormCategoryIDList>
</GetCategoryList>
</soap12:Body>
</soap12:Envelope>

SOAP Body Request Parameters

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

Field Name	Data Type	Length	Required?	Description
FormCategoryIDList	String	8000 chars	NO	CSV list of form category IDs

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>
<GetCategoryListResponse xmlns="https://websvcs.quikforms.com/QFEM/v5000/">
<GetCategoryListResult>
<ErrorCode>int</ErrorCode>
<Message>string</Message>
<ResultData>
<xsd:schema>schema</xsd:schema>xml</ResultData>
<File>base64Binary</File>
</GetCategoryListResult>
</GetCategoryListResponse>
</soap12:Body>
</soap12:Envelope>

Result Fields

Field Name	Data Type	Length	Description
FormCategoryID	Integer		Form category unique ID
FormCategory	String	255 chars	Form category
FormCategoryDesc	String	1000 chars	Form category description

GetFormCategoryXREF Details

The GetFormCategoryXREF method returns a list of forms and their associated categories for use when selecting dealers and forms.

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>
<GetFormCategoryXREF xmlns="https://websvcs.quikforms.com/QFEM/v5000/">
<FormIDList>string</FormIDList>
<FormCategoryIDList>string</FormCategoryIDList>
</GetFormCategoryXREF>
</soap12:Body>
</soap12:Envelope>

SOAP Body Request Parameters

To limit the number of records returned pass in a FormID or FormCategoryID list.

Field Name	Data Type	Length	Direction	Display	Required?	Description
FormIDList	String	8000 chars	In	NO	NO	CSV list of unique form IDs
FormCategoryIDList	String	8000 chars	In	NO	NO	CSV list of form category IDs

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>
<GetFormCategoryXREFResponse xmlns="https://websvcs.quikforms.com/QFEM/v5000/">
<GetFormCategoryXREFResult>
<ErrorCode>int</ErrorCode>
<Message>string</Message>
<ResultData>
<xsd:schema>schema</xsd:schema>xml</ResultData>
<File>base64Binary</File>
</GetFormCategoryXREFResult>
</GetFormCategoryXREFResponse>
</soap12:Body>
</soap12:Envelope>

Result Fields

Field Name	Data Type	Length	Direction	Display	Required?	Description
FormID	Integer		Out	YES	YES	Quik! unique form ID
FormCategoryID	Integer		Out	YES	YES	Form category unique ID

GetFormStateXREF Details

Returns a list of forms and the corresponding state(s) the form applies to. This table only contains a Form ID and State Code when a form is specific to one or more states (e.g. in the case of life insurance forms). If a form does not have an entry in this table, then the form is not state-specific.

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>
<GetFormStateXREF xmlns="https://websvcs.quikforms.com/QFEM/v5000/">
<FormIDList>string</FormIDList>
<StateIDList>string</StateIDList>
</GetFormStateXREF>
</soap12:Body>
</soap12:Envelope>

SOAP Body Request Parameters

The GetFormStateXREF method returns a list of states that apply to each form, which is used to determine the forms to display when a user selects a state.

Field Name	Data Type	Length	Required?	Description
FormIDList	String	8000 chars	NO	CSV list of unique form IDs
StateIDList	String	8000 chars	NO	CSV list of state IDs

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>
<GetFormStateXREFResponse xmlns="https://websvcs.quikforms.com/QFEM/v5000/">
<GetFormStateXREFResult>
<ErrorCode>int</ErrorCode>
<Message>string</Message>
<ResultData>
<xsd:schema>schema</xsd:schema>xml</ResultData>
<File>base64Binary</File>
</GetFormStateXREFResult>
</GetFormStateXREFResponse>
</soap12:Body>
</soap12:Envelope>

Result Fields

Field Name	Data Type	Length	Description
FormID	Integer		Quik! form unique ID
StateID	Integer		State unique ID
StateCode	String	6 chars	State code assigned to the form

GetStatesList Details

Returns a list of states that can be used with forms.

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>
<GetStatesList xmlns="https://websvcs.quikforms.com/QFEM/v5000/">
<StateIDList>string</StateIDList>
</GetStatesList>
</soap12:Body>
</soap12:Envelope>

SOAP Body Request Parameters

To limit the number of states listed, pass in a list of StateIDs to return.

Field Name	Data Type	Length	Direction	Display	Required?	Description
StateIDList	String	8000 chars	In	NO	NO	CSV list of state IDs

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>
<GetStatesListResponse xmlns="https://websvcs.quikforms.com/QFEM/v5000/">
<GetStatesListResult>
<ErrorCode>int</ErrorCode>
<Message>string</Message>
<ResultData>
<xsd:schema>schema</xsd:schema>xml</ResultData>
<File>base64Binary</File>
</GetStatesListResult>
</GetStatesListResponse>
</soap12:Body>
</soap12:Envelope>

Result Fields

Field Name	Data Type	Length	Description
StateID	Integer		State unique ID
StateCode	String	6 chars	State abbreviation
StateName	String	100 chars	Name of the state
SortOrder	Integer		Sort order of states instead of alpha sorting

GetFormTransTypeXREF Details

Returns a list form and the transaction types assigned to the form. Transaction types include "New Account", "Account Update", "Account Transfer", etc. For a list of transaction types, run the GetFormTransTypes method below.

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>
<GetFormTransTypeXREF xmlns="https://websvcs.quikforms.com/QFEM/v5000/">
<FormTransTypeIDList>string</FormTransTypeIDList>
<FormIDList>string</FormIDList>
</GetFormTransTypeXREF>
</soap12:Body>
</soap12:Envelope>

SOAP Body Request Parameters

There are no SOAP Body parameters required to run this method.

Field Name	Data Type	Length	Required?	Description
FormTransTypeIDList	String	8000 chars	NO	CSV list of transaction type IDs
FormIDList	String	8000 chars	NO	CSV list of unique form IDs

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>
<GetFormTransTypeXREFResponse xmlns="https://websvcs.quikforms.com/QFEM/v5000/">
<GetFormTransTypeXREFResult>
<ErrorCode>int</ErrorCode>
<Message>string</Message>
<ResultData>
<xsd:schema>schema</xsd:schema>xml</ResultData>
<File>base64Binary</File>
</GetFormTransTypeXREFResult>
</GetFormTransTypeXREFResponse>
</soap12:Body>
</soap12:Envelope>

Result Fields

Field Name	Data Type	Length	Description
FormID	Integer		Quik! form unique ID
FormTransTypeID	Integer		Transaction type assigned to the form

GetFormTransTypes Details

Returns a list transaction types that can be assigned to a form. Transaction types include "New Account", "Account Update", "Account Transfer", 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>
<GetFormTransTypes xmlns="https://websvcs.quikforms.com/QFEM/v5000/">
<FormTransTypeIDList>string</FormTransTypeIDList>
</GetFormTransTypes>
</soap12:Body>
</soap12:Envelope>

SOAP Body Request Parameters

To limit the number of records return pass in a list of FormTransTypeIDs.

Field Name	Data Type	Length	Direction	Display	Required?	Description
FormTransTypeIDList	String	8000 chars	In	NO	NO	CSV list of transaction type IDs

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>
<GetFormTransTypesResponse xmlns="https://websvcs.quikforms.com/QFEM/v5000/">
<GetFormTransTypesResult>
<ErrorCode>int</ErrorCode>
<Message>string</Message>
<ResultData>
<xsd:schema>schema</xsd:schema>xml</ResultData>
<File>base64Binary</File>
</GetFormTransTypesResult>
</GetFormTransTypesResponse>
</soap12:Body>
</soap12:Envelope>

Result Fields

Field Name	Data Type	Length	Description
FormTransTypeID	Integer		Form transaction type identifier
FormTransType	String	255 chars	Form transaction type
FormTransTypeDesc	String	1000 chars	Form transaction type description

GetFormSignRoles Details

Returns a list signing roles on each form.

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>
<GetFormSignRoles xmlns="https://websvcs.quikforms.com/QFEM/v5000/">
<FormIDList>string</FormIDList>
<DealerIDList>string</DealerIDList>
</GetFormSignRoles>
</soap12:Body>
</soap12:Envelope>

SOAP Body Request Parameters

To limit the number of records return pass in a list of FormTransTypeIDs.

Field Name	Data Type	Length	Direction	Display	Required?	Description
FormIDList	String	8000 chars	In	NO	NO	CSV list of FormIDs
DealerIDList	String	8000 chars	In	NO	NO	CSV list of DealerIDs

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>
<GetFormSignRolesResponse xmlns="https://websvcs.quikforms.com/QFEM/v5000/">
<GetFormSignRolesResult>
<ErrorCode>int</ErrorCode>
<Message>string</Message>
<ResultData>
<xsd:schema>schema</xsd:schema>xml</ResultData>
<File>base64Binary</File>
</GetFormSignRolesResult>
</GetFormSignRolesResponse>
</soap12:Body>
</soap12:Envelope>

Result Fields

The ResultData contains the following fields.

Field Name	Data Type	Length	Description
UNID	Integer		Unique identifier for the role
FormID	Integer		FormID that the signing role is found on
FullFieldName	String	255 chars	Full name of the sign field
RoleInstance	Integer		Instance number of the role (e.g. 1 for Owner 1, 2 for Owner 2, etc.)
FieldName	String	255 chars	The field name for the role (e.g. "own")
FieldShortName	String	255 chars	The short, descriptive name of the role (e.g. "Owner")
SignOrder	Integer		The default order in which the roles should sign (note: RoleInstance further determines the sign order within a role – owner 1 signs before owner 2)

Forms Data – Web Service

Forms Data Methods:

GetFormsList Details

SOAP Request

SOAP Body Request Parameters

SOAP Response

Result Fields

GetDealerList Details

SOAP Request

SOAP Body Request Parameters

SOAP Response

Result Fields

GetDealerTypes Details

SOAP Request

SOAP Body Request Parameters

SOAP Response

Result Fields

GetDealerTypeXREF Details

SOAP Request

SOAP Body Request Parameters

SOAP Response

Result Fields

GetCategoryList Details

SOAP Request

SOAP Body Request Parameters

SOAP Response

Result Fields

GetFormCategoryXREF Details

SOAP Request

SOAP Body Request Parameters

SOAP Response

Result Fields

GetFormStateXREF Details

SOAP Request

SOAP Body Request Parameters

SOAP Response

Result Fields

GetStatesList Details

SOAP Request

SOAP Body Request Parameters

SOAP Response

Result Fields

GetFormTransTypeXREF Details

SOAP Request

SOAP Body Request Parameters

SOAP Response

Result Fields

GetFormTransTypes Details

SOAP Request

SOAP Body Request Parameters

SOAP Response

Result Fields

GetFormSignRoles Details

SOAP Request

SOAP Body Request Parameters

SOAP Response

Result Fields