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

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Header>
    <AuthenticationHeader xmlns="https://websvcs.quikforms.com/QFEM/v5300/">
      <CustomerID>string</CustomerID>
      <UserName>string</UserName>
      <Password>string</Password>
    </AuthenticationHeader>
  </soap:Header>
  <soap:Body>
    <GetFormsList xmlns="https://websvcs.quikforms.com/QFEM/v5300/">
      <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>
  </soap:Body>
</soap: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.

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.

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
RecordCount	Integer		YES	The number of records to return (0 will return all available records)

SOAP Response

GetFormsList SOAP Response

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetFormsListResponse xmlns="https://websvcs.quikforms.com/QFEM/v5300/">
      <GetFormsListResult>
        <ErrorCode>int</ErrorCode>
        <Message>string</Message>
        <ResultData>
          <xsd:schema>schema</xsd:schema>xml</ResultData>
        <File>base64Binary</File>
      </GetFormsListResult>
    </GetFormsListResponse>
  </soap:Body>
</soap: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

GetDealerList SOAP Request

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Header>
    <AuthenticationHeader xmlns="https://websvcs.quikforms.com/QFEM/v5300/">
      <CustomerID>string</CustomerID>
      <UserName>string</UserName>
      <Password>string</Password>
    </AuthenticationHeader>
  </soap:Header>
  <soap:Body>
    <GetDealerList xmlns="https://websvcs.quikforms.com/QFEM/v5300/">
      <DealerIDList>string</DealerIDList>
      <DealerName>string</DealerName>
      <DealerStatusIDList>string</DealerStatusIDList>
      <DealerTypeIDList>string</DealerTypeIDList>
    </GetDealerList>
  </soap:Body>
</soap: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

GetDealerList SOAP Response

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetDealerListResponse xmlns="https://websvcs.quikforms.com/QFEM/v5300/">
      <GetDealerListResult>
        <ErrorCode>int</ErrorCode>
        <Message>string</Message>
        <ResultData>
          <xsd:schema>schema</xsd:schema>xml</ResultData>
        <File>base64Binary</File>
      </GetDealerListResult>
    </GetDealerListResponse>
  </soap:Body>
</soap: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

GetDealerTypes SOAP Request

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Header>
    <AuthenticationHeader xmlns="https://websvcs.quikforms.com/QFEM/v5300/">
      <CustomerID>string</CustomerID>
      <UserName>string</UserName>
      <Password>string</Password>
    </AuthenticationHeader>
  </soap:Header>
  <soap:Body>
    <GetDealerTypes xmlns="https://websvcs.quikforms.com/QFEM/v5300/">
      <DealerTypeIDList>string</DealerTypeIDList>
    </GetDealerTypes>
  </soap:Body>
</soap: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

GetDealerTypes SOAP Response

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetDealerTypesResponse xmlns="https://websvcs.quikforms.com/QFEM/v5300/">
      <GetDealerTypesResult>
        <ErrorCode>int</ErrorCode>
        <Message>string</Message>
        <ResultData>
          <xsd:schema>schema</xsd:schema>xml</ResultData>
        <File>base64Binary</File>
      </GetDealerTypesResult>
    </GetDealerTypesResponse>
  </soap:Body>
</soap: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

GetDealerTypeXREF SOAP Request

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Header>
    <AuthenticationHeader xmlns="https://websvcs.quikforms.com/QFEM/v5300/">
      <CustomerID>string</CustomerID>
      <UserName>string</UserName>
      <Password>string</Password>
    </AuthenticationHeader>
  </soap:Header>
  <soap:Body>
    <GetDealerTypeXREF xmlns="https://websvcs.quikforms.com/QFEM/v5300/">
      <DealerIDList>string</DealerIDList>
      <DealerTypeIDList>string</DealerTypeIDList>
    </GetDealerTypeXREF>
  </soap:Body>
</soap: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

GetDealerTypeXREF SOAP Response

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetDealerTypeXREFResponse xmlns="https://websvcs.quikforms.com/QFEM/v5300/">
      <GetDealerTypeXREFResult>
        <ErrorCode>int</ErrorCode>
        <Message>string</Message>
        <ResultData>
          <xsd:schema>schema</xsd:schema>xml</ResultData>
        <File>base64Binary</File>
      </GetDealerTypeXREFResult>
    </GetDealerTypeXREFResponse>
  </soap:Body>
</soap: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

GetCategoryList SOAP Request

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Header>
    <AuthenticationHeader xmlns="https://websvcs.quikforms.com/QFEM/v5300/">
      <CustomerID>string</CustomerID>
      <UserName>string</UserName>
      <Password>string</Password>
    </AuthenticationHeader>
  </soap:Header>
  <soap:Body>
    <GetCategoryList xmlns="https://websvcs.quikforms.com/QFEM/v5300/">
      <FormCategoryIDList>string</FormCategoryIDList>
    </GetCategoryList>
  </soap:Body>
</soap: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

GetCategoryList SOAP Response

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetCategoryListResponse xmlns="https://websvcs.quikforms.com/QFEM/v5300/">
      <GetCategoryListResult>
        <ErrorCode>int</ErrorCode>
        <Message>string</Message>
        <ResultData>
          <xsd:schema>schema</xsd:schema>xml</ResultData>
        <File>base64Binary</File>
      </GetCategoryListResult>
    </GetCategoryListResponse>
  </soap:Body>
</soap: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

GetFormCategoryXREF Request

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Header>
    <AuthenticationHeader xmlns="https://websvcs.quikforms.com/QFEM/v5300/">
      <CustomerID>string</CustomerID>
      <UserName>string</UserName>
      <Password>string</Password>
    </AuthenticationHeader>
  </soap:Header>
  <soap:Body>
    <GetFormCategoryXREF xmlns="https://websvcs.quikforms.com/QFEM/v5300/">
      <FormIDList>string</FormIDList>
      <FormCategoryIDList>string</FormCategoryIDList>
    </GetFormCategoryXREF>
  </soap:Body>
</soap: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

GetFormCategoryXREF Response

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetFormCategoryXREFResponse xmlns="https://websvcs.quikforms.com/QFEM/v5300/">
      <GetFormCategoryXREFResult>
        <ErrorCode>int</ErrorCode>
        <Message>string</Message>
        <ResultData>
          <xsd:schema>schema</xsd:schema>xml</ResultData>
        <File>base64Binary</File>
      </GetFormCategoryXREFResult>
    </GetFormCategoryXREFResponse>
  </soap:Body>
</soap: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

GetFormStateXREF SOAP Request

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Header>
    <AuthenticationHeader xmlns="https://websvcs.quikforms.com/QFEM/v5300/">
      <CustomerID>string</CustomerID>
      <UserName>string</UserName>
      <Password>string</Password>
    </AuthenticationHeader>
  </soap:Header>
  <soap:Body>
    <GetFormStateXREF xmlns="https://websvcs.quikforms.com/QFEM/v5300/">
      <FormIDList>string</FormIDList>
      <StateIDList>string</StateIDList>
    </GetFormStateXREF>
  </soap:Body>
</soap: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

GetFormStateXREF SOAP Response

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetFormStateXREFResponse xmlns="https://websvcs.quikforms.com/QFEM/v5300/">
      <GetFormStateXREFResult>
        <ErrorCode>int</ErrorCode>
        <Message>string</Message>
        <ResultData>
          <xsd:schema>schema</xsd:schema>xml</ResultData>
        <File>base64Binary</File>
      </GetFormStateXREFResult>
    </GetFormStateXREFResponse>
  </soap:Body>
</soap: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

GetStatesList SOAP Request

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Header>
    <AuthenticationHeader xmlns="https://websvcs.quikforms.com/QFEM/v5300/">
      <CustomerID>string</CustomerID>
      <UserName>string</UserName>
      <Password>string</Password>
    </AuthenticationHeader>
  </soap:Header>
  <soap:Body>
    <GetStatesList xmlns="https://websvcs.quikforms.com/QFEM/v5300/">
      <StateIDList>string</StateIDList>
    </GetStatesList>
  </soap:Body>
</soap: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

GetStatesList SOAP Response

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetStatesListResponse xmlns="https://websvcs.quikforms.com/QFEM/v5300/">
      <GetStatesListResult>
        <ErrorCode>int</ErrorCode>
        <Message>string</Message>
        <ResultData>
          <xsd:schema>schema</xsd:schema>xml</ResultData>
        <File>base64Binary</File>
      </GetStatesListResult>
    </GetStatesListResponse>
  </soap:Body>
</soap: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

GetFormTransTypeXREF SOAP Request

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Header>
    <AuthenticationHeader xmlns="https://websvcs.quikforms.com/QFEM/v5300/">
      <CustomerID>string</CustomerID>
      <UserName>string</UserName>
      <Password>string</Password>
    </AuthenticationHeader>
  </soap:Header>
  <soap:Body>
    <GetFormTransTypeXREF xmlns="https://websvcs.quikforms.com/QFEM/v5300/">
      <FormTransTypeIDList>string</FormTransTypeIDList>
      <FormIDList>string</FormIDList>
    </GetFormTransTypeXREF>
  </soap:Body>
</soap: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

GetFormTransTypeXREF SOAP Response

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetFormTransTypeXREFResponse xmlns="https://websvcs.quikforms.com/QFEM/v5300/">
      <GetFormTransTypeXREFResult>
        <ErrorCode>int</ErrorCode>
        <Message>string</Message>
        <ResultData>
          <xsd:schema>schema</xsd:schema>xml</ResultData>
        <File>base64Binary</File>
      </GetFormTransTypeXREFResult>
    </GetFormTransTypeXREFResponse>
  </soap:Body>
</soap: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

GetFormTransTypes SOAP Request

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Header>
    <AuthenticationHeader xmlns="https://websvcs.quikforms.com/QFEM/v5300/">
      <CustomerID>string</CustomerID>
      <UserName>string</UserName>
      <Password>string</Password>
    </AuthenticationHeader>
  </soap:Header>
  <soap:Body>
    <GetFormTransTypes xmlns="https://websvcs.quikforms.com/QFEM/v5300/">
      <FormTransTypeIDList>string</FormTransTypeIDList>
    </GetFormTransTypes>
  </soap:Body>
</soap: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

GetFormTransTypes SOAP Response

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetFormTransTypesResponse xmlns="https://websvcs.quikforms.com/QFEM/v5300/">
      <GetFormTransTypesResult>
        <ErrorCode>int</ErrorCode>
        <Message>string</Message>
        <ResultData>
          <xsd:schema>schema</xsd:schema>xml</ResultData>
        <File>base64Binary</File>
      </GetFormTransTypesResult>
    </GetFormTransTypesResponse>
  </soap:Body>
</soap: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

GetFormSignRoles SOAP Request

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Header>
    <AuthenticationHeader xmlns="https://websvcs.quikforms.com/QFEM/v5300/">
      <CustomerID>string</CustomerID>
      <UserName>string</UserName>
      <Password>string</Password>
    </AuthenticationHeader>
  </soap:Header>
  <soap:Body>
    <GetFormSignRoles xmlns="https://websvcs.quikforms.com/QFEM/v5300/">
      <FormIDList>string</FormIDList>
      <DealerIDList>string</DealerIDList>
    </GetFormSignRoles>
  </soap:Body>
</soap: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

GetFormSignRoles SOAP Response

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetFormSignRolesResponse xmlns="https://websvcs.quikforms.com/QFEM/v5300/">
      <GetFormSignRolesResult>
        <ErrorCode>int</ErrorCode>
        <Message>string</Message>
        <ResultData>
          <xsd:schema>schema</xsd:schema>xml</ResultData>
        <File>base64Binary</File>
      </GetFormSignRolesResult>
    </GetFormSignRolesResponse>
  </soap:Body>
</soap: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)

GetFormsListByCompanyAndShortName Details

Returns a list of subscribed forms with Company and ShortName parameters. This method differs from GetFormsList because GetFormsList orders results by Dealer, then ShortName, then Publish Date, and it does not search against form description. GetFormsListByCompanyAndShortName orders by Dealer (company), then ShortName, and looks against form name and description.

SOAP Request

GetFormsListByCompanyAndShortName SOAP Request

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Header>
    <AuthenticationHeader xmlns="https://websvcs.quikforms.com/QFEM/v5300/">
      <CustomerID>string</CustomerID>
      <UserName>string</UserName>
      <Password>string</Password>
    </AuthenticationHeader>
  </soap:Header>
  <soap:Body>
    <GetFormsListByCompanyAndShortName xmlns="https://websvcs.quikforms.com/QFEM/v5300/">
      <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>
    </GetFormsListByCompanyAndShortName>
  </soap:Body>
</soap:Envelope>

SOAP Body Request Parameters

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 name (form company)
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	dateTime		NO	The minimum date form was published to Quik! users
PublishDateTo	dateTime		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
RecordCount	int		NO	The number of records to return (0 will return all available records)

SOAP Response

GetFormsListByCompanyAndShortName SOAP Response

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetFormsListByCompanyAndShortNameResponse xmlns="https://websvcs.quikforms.com/QFEM/v5300/">
      <GetFormsListByCompanyAndShortNameResult>
        <ErrorCode>int</ErrorCode>
        <Message>string</Message>
        <ResultData>
          <xsd:schema>schema</xsd:schema>xml</ResultData>
        <File>base64Binary</File>
      </GetFormsListByCompanyAndShortNameResult>
    </GetFormsListByCompanyAndShortNameResponse>
  </soap:Body>
</soap:Envelope>

Result Fields

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
RevisionDate	Date		Date the form was last revised by the owner
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
DealerStatusID	Integer		Dealer status unique ID
DealerStatus	String	255 chars	Dealer status description

GetPublicDealerList Details

Returns a list of all public form dealers in the Quik! form library

SOAP Request

GetPublicDealerList SOAP Request

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

SOAP Body Request Parameters

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
DealerTypeIDList	String	8000 chars	NO	CSV list of dealer type IDs

SOAP Response

GetPublicDealerList SOAP Response

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetPublicDealerListResponse xmlns="https://websvcs.quikforms.com/QFEM/v5300/">
      <GetPublicDealerListResult>
        <ErrorCode>int</ErrorCode>
        <Message>string</Message>
        <ResultData>
          <xsd:schema>schema</xsd:schema>xml</ResultData>
        <File>base64Binary</File>
      </GetPublicDealerListResult>
    </GetPublicDealerListResponse>
  </soap:Body>
</soap:Envelope>

Result Fields

Field Name	DataType	Description
DealerID	Integer	Quik! dealer unique ID
DealerName	String	Quik! dealer name (form company)
DealerStatusID	Integer	1 = active (dealer is active and users can view and use their forms) 2 = inactive (dealer is not active and users cannot view or use their forms) 3 = Not in use (dealer record is not in use and effectively inactive) 4 = delete (dealer record is marked for deletion)
DealerStatus	String	Dealer status description
IsMyCompany

GetDealerListBySecurityLevel Details

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. This method will only return dealers with status = 1.

SOAP Request

GetDealerListBySecurityLevel SOAP Request

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Header>
    <AuthenticationHeader xmlns="https://websvcs.quikforms.com/QFEM/v5300/">
      <CustomerID>string</CustomerID>
      <UserName>string</UserName>
      <Password>string</Password>
    </AuthenticationHeader>
  </soap:Header>
  <soap:Body>
    <GetDealerListBySecurityLevel xmlns="https://websvcs.quikforms.com/QFEM/v5300/">
      <DealerIDList>string</DealerIDList>
      <DealerName>string</DealerName>
      <DealerStatusIDList>string</DealerStatusIDList>
      <DealerTypeIDList>string</DealerTypeIDList>
      <SecurityLevelID>int</SecurityLevelID>
    </GetDealerListBySecurityLevel>
  </soap:Body>
</soap:Envelope>

SOAP Body Request Parameters

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
SecurityLevelID	Int		NO	Security Level IDs 100 = read only (user can only read data, no actions) 200 = edit (user can edit existing data) 300 = add (user can add new records) 400 = configure (user can modify system values)

SOAP Response

GetDealerListBySecurityLevel SOAP Response

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetDealerListBySecurityLevelResponse xmlns="https://websvcs.quikforms.com/QFEM/v5300/">
      <GetDealerListBySecurityLevelResult>
        <ErrorCode>int</ErrorCode>
        <Message>string</Message>
        <ResultData>
          <xsd:schema>schema</xsd:schema>xml</ResultData>
        <File>base64Binary</File>
      </GetDealerListBySecurityLevelResult>
    </GetDealerListBySecurityLevelResponse>
  </soap:Body>
</soap: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		1 = active (dealer is active and users can view and use their forms) 2 = inactive (dealer is not active and users cannot view or use their forms) 3 = Not in use (dealer record is not in use and effectively inactive) 4 = delete (dealer record is marked for deletion)
DealerStatus	String	255 chars	Dealer status description

Form Group Methods

The following methods pertain to managing form groups on your master account by UserID (not by LicenseID - if you are looking for license-based form group management, please see Form Groups by License – Web Service).

AddFormsToGroup Details

This method adds forms to an existing form group. Adding a form that already exists in the group will not create duplicate forms in the same group – the duplicate form will be ignored and return a successful result.

SOAP Request

AddFormsToGroup SOAP Request

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Header>
    <AuthenticationHeader xmlns="https://websvcs.quikforms.com/QFEM/v5300/">
      <CustomerID>string</CustomerID>
      <UserName>string</UserName>
      <Password>string</Password>
    </AuthenticationHeader>
  </soap:Header>
  <soap:Body>
    <AddFormsToGroup xmlns="https://websvcs.quikforms.com/QFEM/v5300/">
      <GroupID>int</GroupID>
      <FormIDs>string</FormIDs>
      <intUserID>int</intUserID>
    </AddFormsToGroup>
  </soap:Body>
</soap:Envelope>

SOAP Body Request Parameters

This method accepts the following parameters.

Field Name	Data Type	Length	Required?	Description
GroupID	Int		YES	The GroupID to add forms to
FormIDs	String	8000 chars	YES	CSV list of unique form IDs to add
intUserID	Int		YES	The UserID that owns the form group

SOAP Response

AddFormsToGroup SOAP Response

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <AddFormsToGroupResponse xmlns="https://websvcs.quikforms.com/QFEM/v5300/">
      <AddFormsToGroupResult>
        <ErrorCode>int</ErrorCode>
        <Message>string</Message>
        <ResultData>
          <xsd:schema>schema</xsd:schema>xml</ResultData>
        <File>base64Binary</File>
      </AddFormsToGroupResult>
    </AddFormsToGroupResponse>
  </soap:Body>
</soap:Envelope>

Result Fields

This method only returns an error code (0 = Success) and a message that indicates the result.

AddGroup Details

This method creates a new form group based on the form group name.

SOAP Request

AddGroup SOAP Request

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Header>
    <AuthenticationHeader xmlns="https://websvcs.quikforms.com/QFEM/v5300/">
      <CustomerID>string</CustomerID>
      <UserName>string</UserName>
      <Password>string</Password>
    </AuthenticationHeader>
  </soap:Header>
  <soap:Body>
    <AddGroup xmlns="https://websvcs.quikforms.com/QFEM/v5300/">
      <GroupName>string</GroupName>
      <Description>string</Description>
      <FormIDs>string</FormIDs>
      <intUserID>int</intUserID>
      <IsPublic>boolean</IsPublic>
    </AddGroup>
  </soap:Body>
</soap:Envelope>

SOAP Body Request Parameters

This method accepts the following parameters.

Field Name	Data Type	Length	Required?	Description
GroupName	String	8000 chars	YES	Unique name of the form group
Description	String	8000 chars	NO	Description of the form group
FormIDs	String	8000 chars	YES	CSV list of unique form IDs to add
intUserID	Int		YES	The UserID that owns the form group
IsPublic	Int		YES	For the Administrator LicenseID only, sets the from group to public or not public for all licenses on the account to view and use the group

SOAP Response

AddGroup SOAP Response

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <AddGroupResponse xmlns="https://websvcs.quikforms.com/QFEM/v5300/">
      <AddGroupResult>
        <ErrorCode>int</ErrorCode>
        <Message>string</Message>
        <ResultData>
          <xsd:schema>schema</xsd:schema>xml</ResultData>
        <File>base64Binary</File>
      </AddGroupResult>
    </AddGroupResponse>
  </soap:Body>
</soap:Envelope>

Result Fields

This method only returns an error code (0 = Success) and a message that indicates the result.

DeleteFormsFromGroup Details

Deletes forms from an existing form group.

SOAP Request

DeleteFormsFromGroup SOAP Request

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Header>
    <AuthenticationHeader xmlns="https://websvcs.quikforms.com/QFEM/v5300/">
      <CustomerID>string</CustomerID>
      <UserName>string</UserName>
      <Password>string</Password>
    </AuthenticationHeader>
  </soap:Header>
  <soap:Body>
    <DeleteFormsFromGroup xmlns="https://websvcs.quikforms.com/QFEM/v5300/">
      <GroupIDs>string</GroupIDs>
      <FormIDs>string</FormIDs>
      <intUserID>int</intUserID>
    </DeleteFormsFromGroup>
  </soap:Body>
</soap:Envelope>

SOAP Body Request Parameters

This method accepts the following parameters.

Field Name	Data Type	Length	Required?	Description
GroupID	Int		YES	The GroupID to update
FormIDs	String	8000 chars	YES	CSV list of unique form IDs to remove
intUserID	Int		YES	The UserID that owns the form group

SOAP Response

DeleteFormsFromGroup SOAP Response

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <DeleteFormsFromGroupResponse xmlns="https://websvcs.quikforms.com/QFEM/v5300/">
      <DeleteFormsFromGroupResult>
        <ErrorCode>int</ErrorCode>
        <Message>string</Message>
        <ResultData>
          <xsd:schema>schema</xsd:schema>xml</ResultData>
        <File>base64Binary</File>
      </DeleteFormsFromGroupResult>
    </DeleteFormsFromGroupResponse>
  </soap:Body>
</soap:Envelope>

Result Fields

This method only returns an error code (0 = Success) and a message that indicates the result.

DeleteGroup Details

Deletes an existing form group.

SOAP Request

DeleteGroup SOAP Request

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Header>
    <AuthenticationHeader xmlns="https://websvcs.quikforms.com/QFEM/v5300/">
      <CustomerID>string</CustomerID>
      <UserName>string</UserName>
      <Password>string</Password>
    </AuthenticationHeader>
  </soap:Header>
  <soap:Body>
    <DeleteGroup xmlns="https://websvcs.quikforms.com/QFEM/v5300/">
      <GroupID>int</GroupID>
      <intUserID>int</intUserID>
    </DeleteGroup>
  </soap:Body>
</soap:Envelope>

SOAP Body Request Parameters

This method accepts the following parameters.

Field Name	Data Type	Length	Required?	Description
GroupID	Int		YES	The GroupID to delete
intUserID	Int		YES	The UserID that owns the form group

SOAP Response

DeleteGroup SOAP Response

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <DeleteGroupResponse xmlns="https://websvcs.quikforms.com/QFEM/v5300/">
      <DeleteGroupResult>
        <ErrorCode>int</ErrorCode>
        <Message>string</Message>
        <ResultData>
          <xsd:schema>schema</xsd:schema>xml</ResultData>
        <File>base64Binary</File>
      </DeleteGroupResult>
    </DeleteGroupResponse>
  </soap:Body>
</soap:Envelope>

Result Fields

This method only returns an error code (0 = Success) and a message that indicates the result.

EditFormGroup Details

Edits an existing form group's properties.

SOAP Request

EditFormGroup SOAP Request

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Header>
    <AuthenticationHeader xmlns="https://websvcs.quikforms.com/QFEM/v5300/">
      <CustomerID>string</CustomerID>
      <UserName>string</UserName>
      <Password>string</Password>
    </AuthenticationHeader>
  </soap:Header>
  <soap:Body>
    <EditFormGroup xmlns="https://websvcs.quikforms.com/QFEM/v5300/">
      <intUserID>int</intUserID>
      <QFFormGroupID>int</QFFormGroupID>
      <FormGroupName>string</FormGroupName>
      <IsPublic>boolean</IsPublic>
    </EditFormGroup>
  </soap:Body>
</soap:Envelope>

SOAP Body Request Parameters

This method accepts the following parameters.

Field Name	Data Type	Length	Required?	Description
intUserID	Int		YES	The UserID that owns the form group
QFFormGroupID	Int		YES	The form group to edit
FormGroupName	String		NO	The new name of the group – if blank, no change will be made
ISPublic	String		NO	Sets the form group to public or non-public for the Administrator LicenseID only

SOAP Response

EditFormGroup SOAP Response

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <EditFormGroupResponse xmlns="https://websvcs.quikforms.com/QFEM/v5300/">
      <EditFormGroupResult>
        <ErrorCode>int</ErrorCode>
        <Message>string</Message>
        <ResultData>
          <xsd:schema>schema</xsd:schema>xml</ResultData>
        <File>base64Binary</File>
      </EditFormGroupResult>
    </EditFormGroupResponse>
  </soap:Body>
</soap:Envelope>

Result Fields

This method only returns an error code (0 = Success) and a message that indicates the result.

FormGroups Details

Returns a list of form groups for the given LicenseID and any public form groups.

SOAP Request

FormGroups SOAP Request

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Header>
    <AuthenticationHeader xmlns="https://websvcs.quikforms.com/QFEM/v5300/">
      <CustomerID>string</CustomerID>
      <UserName>string</UserName>
      <Password>string</Password>
    </AuthenticationHeader>
  </soap:Header>
  <soap:Body>
    <FormGroups xmlns="https://websvcs.quikforms.com/QFEM/v5300/">
      <intUserID>int</intUserID>
    </FormGroups>
  </soap:Body>
</soap:Envelope>

SOAP Body Request Parameters

This method accepts the following parameters.

Field Name	Data Type	Length	Required?	Description
intUserID	Int		YES	The UserID to retrieve form groups for.

SOAP Response

FormGroups SOAP Response

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <FormGroupsResponse xmlns="https://websvcs.quikforms.com/QFEM/v5300/">
      <FormGroupsResult>
        <ErrorCode>int</ErrorCode>
        <Message>string</Message>
        <ResultData>
          <xsd:schema>schema</xsd:schema>xml</ResultData>
        <File>base64Binary</File>
      </FormGroupsResult>
    </FormGroupsResponse>
  </soap:Body>
</soap:Envelope>

Result Fields

This method returns a list of form groups with the columns list below.

Field Name	Data Type	Length	Description
QFFormGroupID	Int		The Form Group ID
FormGroupName	String		The name of the form group
FormGroupDesc	String		The description of the form group
IsPublic	Int		0 (false) means the form group is not public and only available to the License ID, 1 (true) means the form group is available to all licenses on the customer account.

FormGroupsWithFormsByUserID Details

Returns a list of forms for the Form Groups for the provided UserID.

SOAP Request

FormGroupsWithFormsByUserID SOAP Request

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Header>
    <AuthenticationHeader xmlns="https://websvcs.quikforms.com/QFEM/v5300/">
      <CustomerID>string</CustomerID>
      <UserName>string</UserName>
      <Password>string</Password>
    </AuthenticationHeader>
  </soap:Header>
  <soap:Body>
    <FormGroupsWithFormsByUserID xmlns="https://websvcs.quikforms.com/QFEM/v5300/">
      <intUserID>int</intUserID>
    </FormGroupsWithFormsByUserID>
  </soap:Body>
</soap:Envelope>

SOAP Body Request Parameters

This method accepts the following parameters.

Field Name	Data Type	Length	Required?	Description
intUserID	int		YES	UserID that owns the form groups

SOAP Response

FormGroupsWithFormsByUserID SOAP Response

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <FormGroupsWithFormsByUserIDResponse xmlns="https://websvcs.quikforms.com/QFEM/v5300/">
      <FormGroupsWithFormsByUserIDResult>
        <ErrorCode>int</ErrorCode>
        <Message>string</Message>
        <ResultData>
          <xsd:schema>schema</xsd:schema>xml</ResultData>
        <File>base64Binary</File>
      </FormGroupsWithFormsByUserIDResult>
    </FormGroupsWithFormsByUserIDResponse>
  </soap:Body>
</soap:Envelope>

Result Fields

This method returns a list of forms in the selected form group(s) with the following columns.

Field Name	Data Type	Description
QFFormGroupID	Int	The Form Group ID
QFFormID	Int	The Quik! FormID
QFDealerID	Int	The ID for the company that owns the form (Dealer or Carrier or Sponsor, etc.)
QFDealerName	String	The name of the company that owns the form (to display to users)
QFFormShortName	String	The short name of the form (to display to users)
QFFormStatusID	Int	The ID for the form status
QFFormStatus	String	The status of the form (to display to users)
RevisionDate	Date	Date the form was last revised by the owner
QFFormDesc	String	The form's description and purpose
LitNo	String	The form owner's internal form identifier (if any)
PublishDate	Date	Date the form was last published by Quik!

FormsByGroupIDs Details

Returns a list of forms for the given Form Group IDs.

SOAP Request

FormsByGroupIDs SOAP Request

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Header>
    <AuthenticationHeader xmlns="https://websvcs.quikforms.com/QFEM/v5300/">
      <CustomerID>string</CustomerID>
      <UserName>string</UserName>
      <Password>string</Password>
    </AuthenticationHeader>
  </soap:Header>
  <soap:Body>
    <FormsByGroupIDs xmlns="https://websvcs.quikforms.com/QFEM/v5300/">
      <GroupIDs>string</GroupIDs>
    </FormsByGroupIDs>
  </soap:Body>
</soap:Envelope>

SOAP Body Request Parameters

This method accepts the following parameters.

Field Name	Data Type	Length	Required?	Description
GroupIDs	String	8000 chars	NO	CSV list of unique form group IDs

SOAP Response

FormsByGroupIDs SOAP Response

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <FormsByGroupIDsResponse xmlns="https://websvcs.quikforms.com/QFEM/v5300/">
      <FormsByGroupIDsResult>
        <ErrorCode>int</ErrorCode>
        <Message>string</Message>
        <ResultData>
          <xsd:schema>schema</xsd:schema>xml</ResultData>
        <File>base64Binary</File>
      </FormsByGroupIDsResult>
    </FormsByGroupIDsResponse>
  </soap:Body>
</soap:Envelope>

Result Fields

This method returns a list of forms in the selected form group(s) with the following columns.

Field Name	Data Type	Description
QFFormID	Int	The Quik! FormID
QFDealerID	Int	The ID for the company that owns the form (Dealer or Carrier or Sponsor, etc.)
QFDealerName	String	The name of the company that owns the form (to display to users)
QFFormShortName	String	The short name of the form (to display to users)
QFFormStatusID	Int	The ID for the form status
QFFormStatus	String	The status of the form (to display to users)
RevisionDate	Date	Date the form was last revised by the owner
QFFormDesc	String	The form's description and purpose
LitNo	String	The form owner's internal form identifier (if any)
PublishDate	Date	Date the form was last published by Quik!

AddFormsToGroupByCustomerID Details

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

SOAP Request

AddFormsToGroupByCustomerID SOAP Request

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Header>
    <AuthenticationHeader xmlns="https://websvcs.quikforms.com/QFEM/v5300/">
      <CustomerID>string</CustomerID>
      <UserName>string</UserName>
      <Password>string</Password>
    </AuthenticationHeader>
  </soap:Header>
  <soap:Body>
    <AddFormsToGroupByCustomerID xmlns="https://websvcs.quikforms.com/QFEM/v5300/">
      <GroupID>int</GroupID>
      <FormIDs>string</FormIDs>
    </AddFormsToGroupByCustomerID>
  </soap:Body>
</soap:Envelope>

SOAP Body Request Parameters

This method accepts the following parameters.

Field Name	Data Type	Length	Required?	Description
GroupID	Int		YES	The GroupID to add forms to
FormIDs	String	8000 chars	YES	CSV list of unique form IDs to add

SOAP Response

AddFormsToGroupByCustomerID SOAP Response

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <AddFormsToGroupByCustomerIDResponse xmlns="https://websvcs.quikforms.com/QFEM/v5300/">
      <AddFormsToGroupByCustomerIDResult>
        <ErrorCode>int</ErrorCode>
        <Message>string</Message>
        <ResultData>
          <xsd:schema>schema</xsd:schema>xml</ResultData>
        <File>base64Binary</File>
      </AddFormsToGroupByCustomerIDResult>
    </AddFormsToGroupByCustomerIDResponse>
  </soap:Body>
</soap:Envelope>

Result Fields

This method only returns an error code (0 = Success) and a message that indicates the result.

AddGroupByCustomerID Details

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

SOAP Request

AddGroupByCustomerID SOAP Request

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Header>
    <AuthenticationHeader xmlns="https://websvcs.quikforms.com/QFEM/v5300/">
      <CustomerID>string</CustomerID>
      <UserName>string</UserName>
      <Password>string</Password>
    </AuthenticationHeader>
  </soap:Header>
  <soap:Body>
    <AddGroupByCustomerID xmlns="https://websvcs.quikforms.com/QFEM/v5300/">
      <GroupName>string</GroupName>
      <Description>string</Description>
      <FormIDs>string</FormIDs>
    </AddGroupByCustomerID>
  </soap:Body>
</soap:Envelope>

SOAP Body Request Parameters

This method accepts the following parameters.

Field Name	Data Type	Length	Required?	Description
GroupName	String	8000 chars	YES	Unique name of the form group
Description	String	8000 chars	NO	Description of the form group
FormIDs	String	8000 chars	YES	CSV list of unique form IDs to add

SOAP Response

AddGroupByCustomerID SOAP Response

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <AddGroupByCustomerIDResponse xmlns="https://websvcs.quikforms.com/QFEM/v5300/">
      <AddGroupByCustomerIDResult>
        <ErrorCode>int</ErrorCode>
        <Message>string</Message>
        <ResultData>
          <xsd:schema>schema</xsd:schema>xml</ResultData>
        <File>base64Binary</File>
      </AddGroupByCustomerIDResult>
    </AddGroupByCustomerIDResponse>
  </soap:Body>
</soap:Envelope>

Result Fields

This method only returns an error code (0 = Success) and a message that indicates the result.

DeleteFormsFromGroupByCustomerID Details

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

SOAP Request

DeleteFormsFromGroupByCustomerID SOAP Request

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:xsd="http://www.w3.org/2001/XMLSchema"
    xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
    <soap:Header>
        <AuthenticationHeader
            xmlns="https://websvcs.quikforms.com/QFEM/v5300/">
            <CustomerID>string</CustomerID>
            <UserName>string</UserName>
            <Password>string</Password>
        </AuthenticationHeader>
    </soap:Header>
    <soap:Body>
        <DeleteFormsFromGroupByCustomerID
            xmlns="https://websvcs.quikforms.com/QFEM/v5300/">
            <GroupIDs>string</GroupIDs>
            <FormIDs>string</FormIDs>
        </DeleteFormsFromGroupByCustomerID>
    </soap:Body>
</soap:Envelope>

SOAP Body Request Parameters

This method accepts the following parameters.

Field Name	Data Type	Length	Required?	Description
GroupID	Int		YES	The GroupID to update
FormIDs	String	8000 chars	YES	CSV list of unique form IDs to remove

SOAP Response

DeleteFormsFromGroupByCustomerID SOAP Response

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <DeleteFormsFromGroupByCustomerIDResponse xmlns="https://websvcs.quikforms.com/QFEM/v5300/">
      <DeleteFormsFromGroupByCustomerIDResult>
        <ErrorCode>int</ErrorCode>
        <Message>string</Message>
        <ResultData>
          <xsd:schema>schema</xsd:schema>xml</ResultData>
        <File>base64Binary</File>
      </DeleteFormsFromGroupByCustomerIDResult>
    </DeleteFormsFromGroupByCustomerIDResponse>
  </soap:Body>
</soap:Envelope>

Result Fields

This method only returns an error code (0 = Success) and a message that indicates the result.

DeleteGroupByCustomerID Details

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

SOAP Request

DeleteGroupByCustomerID SOAP Request

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Header>
    <AuthenticationHeader xmlns="https://websvcs.quikforms.com/QFEM/v5300/">
      <CustomerID>string</CustomerID>
      <UserName>string</UserName>
      <Password>string</Password>
    </AuthenticationHeader>
  </soap:Header>
  <soap:Body>
    <DeleteGroupByCustomerID xmlns="https://websvcs.quikforms.com/QFEM/v5300/">
      <GroupID>int</GroupID>
    </DeleteGroupByCustomerID>
  </soap:Body>
</soap:Envelope>

SOAP Body Request Parameters

This method accepts the following parameters.

Field Name	Data Type	Length	Required?	Description
GroupID	Int		YES	The GroupID to delete

SOAP Response

DeleteGroupByCustomerID SOAP Response

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <DeleteGroupByCustomerIDResponse xmlns="https://websvcs.quikforms.com/QFEM/v5300/">
      <DeleteGroupByCustomerIDResult>
        <ErrorCode>int</ErrorCode>
        <Message>string</Message>
        <ResultData>
          <xsd:schema>schema</xsd:schema>xml</ResultData>
        <File>base64Binary</File>
      </DeleteGroupByCustomerIDResult>
    </DeleteGroupByCustomerIDResponse>
  </soap:Body>
</soap:Envelope>

Result Fields

This method only returns an error code (0 = Success) and a message that indicates the result.

EditFormGroupByCustomerID Details

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

SOAP Request

EditFormGroupByCustomerID SOAP Request

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Header>
    <AuthenticationHeader xmlns="https://websvcs.quikforms.com/QFEM/v5300/">
      <CustomerID>string</CustomerID>
      <UserName>string</UserName>
      <Password>string</Password>
    </AuthenticationHeader>
  </soap:Header>
  <soap:Body>
    <EditFormGroupByCustomerID xmlns="https://websvcs.quikforms.com/QFEM/v5300/">
      <QFFormGroupID>int</QFFormGroupID>
      <FormGroupName>string</FormGroupName>
      <IsPublic>boolean</IsPublic>
    </EditFormGroupByCustomerID>
  </soap:Body>
</soap:Envelope>

SOAP Body Request Parameters

This method accepts the following parameters.

Field Name	Data Type	Length	Required?	Description
QFFormGroupID	Int		YES	The form group to edit
FormGroupName	String		NO	The new name of the group – if blank, no change will be made
ISPublic	String		NO	Sets the form group to public or non-public for the Administrator LicenseID only

SOAP Response

EditFormGroupByCustomerID SOAP Response

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <EditFormGroupByCustomerIDResponse xmlns="https://websvcs.quikforms.com/QFEM/v5300/">
      <EditFormGroupByCustomerIDResult>
        <ErrorCode>int</ErrorCode>
        <Message>string</Message>
        <ResultData>
          <xsd:schema>schema</xsd:schema>xml</ResultData>
        <File>base64Binary</File>
      </EditFormGroupByCustomerIDResult>
    </EditFormGroupByCustomerIDResponse>
  </soap:Body>
</soap:Envelope>

Result Fields

This method only returns an error code (0 = Success) and a message that indicates the result.

FormGroupsByCustomerID Details

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

SOAP Request

FormGroupsByCustomerID SOAP Request

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

SOAP Body Request Parameters

This method accepts no parameters

SOAP Response

FormGroupsByCustomerID SOAP Response

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <FormGroupsByCustomerIDResponse xmlns="https://websvcs.quikforms.com/QFEM/v5300/">
      <FormGroupsByCustomerIDResult>
        <ErrorCode>int</ErrorCode>
        <Message>string</Message>
        <ResultData>
          <xsd:schema>schema</xsd:schema>xml</ResultData>
        <File>base64Binary</File>
      </FormGroupsByCustomerIDResult>
    </FormGroupsByCustomerIDResponse>
  </soap:Body>
</soap:Envelope>

Result Fields

This method returns a list of form groups with the columns list below.

Field Name	Data Type	Length	Description
QFFormGroupID	Int		The Form Group ID
FormGroupName	String		The name of the form group

Forms Data - Web Service

Forms Data Methods

Form Group 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

GetFormsListByCompanyAndShortName Details

SOAP Request

SOAP Body Request Parameters

SOAP Response

Result Fields

GetPublicDealerList Details

SOAP Request

SOAP Body Request Parameters

SOAP Response

Result Fields

GetDealerListBySecurityLevel Details

SOAP Request

SOAP Body Request Parameters

SOAP Response

Result Fields

Form Group Methods

AddFormsToGroup Details

SOAP Request

SOAP Body Request Parameters

SOAP Response

Result Fields

AddGroup Details