Configuration – Web Service
- Cheryl Dillon (Unlicensed)
The miscellaneous configuration methods and options are available in the QFEConfigWS.
PLEASE VISIT THE URL'S BELOW FOR THE LATEST XML FORMAT
Service URL: https://websvcs.quikforms.com/qfe_ws/v5200/QFEConfigWS.asmx
Service WSDL: https://websvcs.quikforms.com/qfe_ws/v5200/QFEConfigWS.asmx?WSDL
Methods:
The following methods are used to perform various functions useful to manage your implementation or Sample Website using the Quik! Forms Engine software.
- ClientRoleList_by_FormIDs – description
- GetFieldFullName– description
- GetFirstPageImages – description
- GetMappingFields – description
- GetQuikFields – description
- SaveMappedFields – description
ClientRoleList_by_FormIDs
Returns the list of client roles available on the provided FormIDs. This list is used to help a user assign a client record to a specific role on the form and to only display the roles available on the selected forms.
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="http://websvcs.quikforms.com/QFEM/">
<CustomerID>string</CustomerID>
<UserName>string</UserName>
<Password>string</Password>
</AuthenticationHeader>
</soap:Header>
<soap:Body>
<ClientRoleList_by_FormIDs xmlns="http://websvcs.quikforms.com/QFEM/">
<FormIDs>string</FormIDs>
</ClientRoleList_by_FormIDs>
</soap:Body>
</soap:Envelope>
SOAP Body Request Parameters
This method accepts the following parameters.
Field Name |
Data Type |
Length |
Required? |
Description |
FormIDsList |
String |
8000 chars |
YES |
CSV list of unique form IDs |
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>
<ClientRoleList_by_FormIDsResponse xmlns="http://websvcs.quikforms.com/QFEM/">
<ClientRoleList_by_FormIDsResult>
<ErrorCode>int</ErrorCode>
<Message>string</Message>
<ResultData>
<xsd:schema>schema</xsd:schema>xml</ResultData>
</ClientRoleList_by_FormIDsResult>
</ClientRoleList_by_FormIDsResponse>
</soap:Body>
</soap:Envelope>
Result Fields
This method returns a table of client roles that exist on the provided forms so a user can assign their client records to each role for prefilling the forms.
Field Name |
Data Type |
Length |
Description |
RoleID |
Int |
|
A unique ID for the field |
QFDLevel1FieldID |
Int |
|
The internal ID for the Quik! Parent Field |
FieldName |
String |
|
The field name of the Quik! Parent Field or role |
RoleInstance |
Int |
|
The role instance number (e.g. 1 for the first role, 2 for the second role, etc.) |
GetFieldFullName
Returns a list of the Quik! Field Names for a given FormID, Level1FieldID (internal value for Quik!'s use only) and/or the field's SystemName.
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="http://websvcs.quikforms.com/QFEM/">
<CustomerID>string</CustomerID>
<UserName>string</UserName>
<Password>string</Password>
</AuthenticationHeader>
</soap:Header>
<soap:Body>
<GetFieldFullName xmlns="http://websvcs.quikforms.com/QFEM/">
<SystemName>string</SystemName>
<DataSetTypeID>int</DataSetTypeID>
</GetFieldFullName>
</soap:Body>
</soap:Envelope>
SOAP Body Request Parameters
This method accepts the following parameters.
Field Name |
Data Type |
Length |
Required? |
Description |
SystemName |
String |
8000 chars |
NO |
The System Name for a field |
DataSetTypeID |
Int |
|
NO |
The DataSetTypeID to return DataSetTypeIDDataSetType |
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>
<GetFieldFullNameResponse xmlns="http://websvcs.quikforms.com/QFEM/">
<GetFieldFullNameResult>
<ErrorCode>int</ErrorCode>
<Message>string</Message>
<ResultData>
<xsd:schema>schema</xsd:schema>xml</ResultData>
</GetFieldFullNameResult>
</GetFieldFullNameResponse>
</soap:Body>
</soap:Envelope>
Result Fields
This method returns a field name for a given Form, Level1FieldID and/or SystemName.
Field Name |
Data Type |
Length |
Description |
FullFieldName |
String |
|
The full field name, not including the role (e.g. "FName" would result from the system name "FirstName") |
GetFirstPageImages
Returns URLs to thumbnail images of the first page in a form to show users in a search result or preview of the form.
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="http://websvcs.quikforms.com/QFEM/">
<CustomerID>string</CustomerID>
<UserName>string</UserName>
<Password>string</Password>
</AuthenticationHeader>
</soap:Header>
<soap:Body>
<GetFirstPageImages xmlns="http://websvcs.quikforms.com/QFEM/">
<FormIDs>string</FormIDs>
</GetFirstPageImages>
</soap:Body>
</soap:Envelope>
SOAP Body Request Parameters
This method accepts the following parameters.
Field Name |
Data Type |
Length |
Required? |
Description |
FormIDs |
String |
8000 chars |
YES |
CSV list of unique form IDs |
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>
<GetFirstPageImagesResponse xmlns="http://websvcs.quikforms.com/QFEM/">
<GetFirstPageImagesResult>
<ErrorCode>int</ErrorCode>
<Message>string</Message>
<ResultData>
<xsd:schema>schema</xsd:schema>xml</ResultData>
</GetFirstPageImagesResult>
</GetFirstPageImagesResponse>
</soap:Body>
</soap:Envelope>
Result Fields
This method returns a list of FormIDs and URLs to their form image.
Field Name |
Data Type |
Length |
Description |
QFFormID |
Int |
|
The Quik! FormID |
FirstPageURL |
String |
|
The URL to the thumbnail image of the first page in the form. The URL is encrypted and automatically expires, so the URL should not be stored and re-used. |
GetMappingFields
Returns a mapping table of customer data fields and their related Quik! field. This field mapping is used to map data from a data source to the Quik! form field naming convention. If this table is empty then no fields have been mapped for the customer (call SaveMappedFields first).
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="http://websvcs.quikforms.com/QFEM/">
<CustomerID>string</CustomerID>
<UserName>string</UserName>
<Password>string</Password>
</AuthenticationHeader>
</soap:Header>
<soap:Body>
<GetMappingFields xmlns="http://websvcs.quikforms.com/QFEM/">
<ForClients>boolean</ForClients>
</GetMappingFields>
</soap:Body>
</soap:Envelope>
SOAP Body Request Parameters
This method accepts the following parameters.
Field Name |
Data Type |
Length |
Required? |
Description |
ForClients |
Boolean |
|
YES |
If TRUE returns mapping fields for clients. If FALSE returns mapping fields for reps. |
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>
<GetMappingFieldsResponse xmlns="http://websvcs.quikforms.com/QFEM/">
<GetMappingFieldsResult>
<ErrorCode>int</ErrorCode>
<Message>string</Message>
<ResultData>
<xsd:schema>schema</xsd:schema>xml</ResultData>
</GetMappingFieldsResult>
</GetMappingFieldsResponse>
</soap:Body>
</soap:Envelope>
Result Fields
This method returns a field mapping table showing the Quik! Field Name that is mapped to a customer's data source field name.
Field Name |
Data Type |
Length |
Description |
QDBCDataSourceMappingID |
Int |
|
The unique record ID for the mapping field |
QuikFieldName |
String |
|
The Quik! field name |
QFDLevel2FieldID |
Int |
|
The ID of the base field name |
QFDLevel3FieldID |
Int |
|
The ID of the sub-base field name |
QDBCDataSourceFieldName |
String |
|
The customer's mapped field name |
GetQuikFields
Returns the list of Quik! Fields available for mapping.
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="http://websvcs.quikforms.com/QFEM/">
<CustomerID>string</CustomerID>
<UserName>string</UserName>
<Password>string</Password>
</AuthenticationHeader>
</soap:Header>
<soap:Body>
<GetQuikFields xmlns="http://websvcs.quikforms.com/QFEM/">
<ForClients>boolean</ForClients>
</GetQuikFields>
</soap:Body>
</soap:Envelope>
SOAP Body Request Parameters
This method accepts the following parameters.
Field Name |
Data Type |
Length |
Required? |
Description |
ForClients |
Boolean |
|
YES |
If TRUE returns mapping fields for clients. If FALSE returns mapping fields for reps. |
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>
<GetQuikFieldsResponse xmlns="http://websvcs.quikforms.com/QFEM/">
<GetQuikFieldsResult>
<ErrorCode>int</ErrorCode>
<Message>string</Message>
<ResultData>
<xsd:schema>schema</xsd:schema>xml</ResultData>
</GetQuikFieldsResult>
</GetQuikFieldsResponse>
</soap:Body>
</soap:Envelope>
Result Fields
This method returns a list of the Quik! Client base field names.
Field Name |
Data Type |
Length |
Description |
ItemIndex |
Int |
|
The unique ID for the field name record |
QuikFields |
String |
|
The name of the Quik! field |
SaveMappedFields
Save your field mapping assignments to Quik! for retrieval later to use when prepopulating the form data into the Quik! Forms Engine.
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="http://websvcs.quikforms.com/QFEM/">
<CustomerID>string</CustomerID>
<UserName>string</UserName>
<Password>string</Password>
</AuthenticationHeader>
</soap:Header>
<soap:Body>
<SaveMappedFields xmlns="http://websvcs.quikforms.com/QFEM/">
<MappedFieldIndex>string</MappedFieldIndex>
<QuikFieldIndex>string</QuikFieldIndex>
<ClientFields>
<string>string</string>
<string>string</string>
</ClientFields>
<DataSetTypeID>int</DataSetTypeID>
</SaveMappedFields>
</soap:Body>
</soap:Envelope>
SOAP Body Request Parameters
This method accepts the following parameters.
Field Name |
Data Type |
Length |
Required? |
Description |
MappedFieldIndex |
String |
8000 chars |
YES |
|
QuikFieldIndex |
String |
8000 chars |
YES |
|
ClientFields – string |
String |
8000 chars |
YES |
|
DataSetTypeID |
Int |
|
NO |
The DataSetTypeID to return DataSetTypeIDDataSetType |
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>
<SaveMappedFieldsResponse xmlns="http://websvcs.quikforms.com/QFEM/">
<SaveMappedFieldsResult>
<ErrorCode>int</ErrorCode>
<Message>string</Message>
<ResultData>
<xsd:schema>schema</xsd:schema>xml</ResultData>
</SaveMappedFieldsResult>
</SaveMappedFieldsResponse>
</soap:Body>
</soap:Envelope>
Result Fields
This method only returns an error code (0 = Success) and a message that indicates the result.
Related content
For help regarding Quik! Forms and the Quik! API
Email: support@quikforms.com | Phone: (877) 456-QUIK