Versions Compared

Version Old Version 2 New Version Current
Changes made by

Rich Walker

Rich Walker

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

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
Production URL: https://uatwebsvcswebsvcs.quikforms.com/qfem/v5500/formsdatawebservice.asmx  
WSDL: https://uatwebsvcswebsvcs.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").

...

<?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>
<RecordCount>int</RecordCount>
</GetFormsList>
</soap12:Body>
</soap12:Envelope>

...

<?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>

...

<?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>

...

<?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>

...

<?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>

...

<?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>

...

<?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>

...

<?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>

...

<?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>

...

<?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>

...

<?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>

...

<?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>

...

<?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>

...

<?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>

...

<?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>

...

<?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>

...

<?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>

...

<?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>

...

<?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>

...

<?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>

...

<?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>

...

<?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>

...