Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 6 Next »

The methods in the following web service will enable you to set up, manage and use form groups for your licenses (see License Manager Web Service to manage licenses).

PLEASE VISIT THE URL'S BELOW FOR THE LATEST XML FORMAT

Service URL: https://websvcs.quikforms.com/qfe_ws/v5500/FormGroupsWS.asmx
Service WSDL: https://websvcs.quikforms.com/qfe_ws/v5500/FormGroupsWS.asmx?WSDL

Methods:

The following methods are used to manage form groups for your account. Form Groups are created by LicenseID. Form Groups created for the Admin License can be set to public and shared with all licenses on your account; form groups created for all other licenses may only be viewed by that license.

  • 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
  • Forms_by_GroupIDs – Return the forms within one or more form groups


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

XML
<?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:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Header>
<AuthenticationHeader xmlns="http://websvcs.quikforms.com/QFEM/">
<CustomerID>string</CustomerID>
<UserName>string</UserName>
<Password>string</Password>
</AuthenticationHeader>
</soap12:Header>
<soap12:Body>
<AddFormsToGroup xmlns="http://websvcs.quikforms.com/QFEM/">
<GroupID>int</GroupID>
<FormIDs>string</FormIDs>
<LicenseID>int</LicenseID>
</AddFormsToGroup>
</soap12:Body>
</soap12: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

LicenseID

Int


YES

The LicenseID that owns the form group

SOAP Response

XML
<?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:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<AddFormsToGroupResponse xmlns="http://websvcs.quikforms.com/QFEM/">
<AddFormsToGroupResult>
<ErrorCode>int</ErrorCode>
<Message>string</Message>
<ResultData>
<xsd:schema>schema</xsd:schema>xml</ResultData>
</AddFormsToGroupResult>
</AddFormsToGroupResponse>
</soap12:Body>
</soap12: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

XML
<?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>
<AddGroup xmlns="http://websvcs.quikforms.com/QFEM/">
<GroupName>string</GroupName>
<Description>string</Description>
<FormIDs>string</FormIDs>
<LicenseID>int</LicenseID>
<IsPublic>int</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

LicenseID

Int


YES

The LicenseID 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

XML
<?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="http://websvcs.quikforms.com/QFEM/">
<AddGroupResult>
<ErrorCode>int</ErrorCode>
<Message>string</Message>
<ResultData>
<xsd:schema>schema</xsd:schema>xml</ResultData>
</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

Deletes forms from an existing form group.

SOAP Request

XML
<?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>
<DeleteFormsFromGroup xmlns="http://websvcs.quikforms.com/QFEM/">
<GroupIDs>string</GroupIDs>
<FormIDs>string</FormIDs>
<LicenseID>int</LicenseID>
</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

LicenseID

Int


YES

The LicenseID that owns the form group

SOAP Response

XML
<?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="http://websvcs.quikforms.com/QFEM/">
<DeleteFormsFromGroupResult>
<ErrorCode>int</ErrorCode>
<Message>string</Message>
<ResultData>
<xsd:schema>schema</xsd:schema>xml</ResultData>
</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

Deletes an existing form group.

SOAP Request

XML
<?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>
<DeleteGroup xmlns="http://websvcs.quikforms.com/QFEM/">
<GroupID>int</GroupID>
<LicenseID>int</LicenseID>
</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

LicenseID

Int


YES

The LicenseID that owns the form group

SOAP Response

XML
<?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="http://websvcs.quikforms.com/QFEM/">
<DeleteGroupResult>
<ErrorCode>int</ErrorCode>
<Message>string</Message>
<ResultData>
<xsd:schema>schema</xsd:schema>xml</ResultData>
</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

Edits an existing form group's properties.

SOAP Request

XML
<?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>
<EditFormGroup xmlns="http://websvcs.quikforms.com/QFEM/">
<LicenseID>int</LicenseID>
<QFFormGroupID>int</QFFormGroupID>
<FormGroupName>string</FormGroupName>
<IsPublic>string</IsPublic>
</EditFormGroup>
</soap:Body>
</soap:Envelope>

SOAP Body Request Parameters

This method accepts the following parameters.

Field Name

Data Type

Length

Required?

Description

LicenseID

Int


YES

The LicenseID 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

XML
<?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="http://websvcs.quikforms.com/QFEM/">
<FormGroupsResult>
<ErrorCode>int</ErrorCode>
<Message>string</Message>
<ResultData>
<xsd:schema>schema</xsd:schema>xml</ResultData>
</FormGroupsResult>
</FormGroupsResponse>
</soap:Body>
</soap:Envelope>

Result Fields

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

FormGroups

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

SOAP Request

XML
<?xml version="1.0" encoding="utf-8"?>
<?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>
<FormGroups xmlns="http://websvcs.quikforms.com/QFEM/">
<LicenseID>int</LicenseID>
</FormGroups>
</soap:Body>
</soap:Envelope>

SOAP Body Request Parameters

This method accepts the following parameters.

Field Name

Data Type

Length

Required?

Description

LicenseID

Int


YES

The License ID to retrieve form groups for.

SOAP Response

XML
<?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="http://websvcs.quikforms.com/QFEM/">
<EditFormGroupResult>
<ErrorCode>int</ErrorCode>
<Message>string</Message>
<ResultData>
<xsd:schema>schema</xsd:schema>xml</ResultData>
</EditFormGroupResult>
</EditFormGroupResponse>
</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.


FormsbyGroupIDs

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

SOAP Request

XML
<?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>
<Forms_by_GroupIDs xmlns="http://websvcs.quikforms.com/QFEM/">
<GroupIDs>string</GroupIDs>
</Forms_by_GroupIDs>
</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

XML
<?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>
<Forms_by_GroupIDsResponse xmlns="http://websvcs.quikforms.com/QFEM/">
<Forms_by_GroupIDsResult>
<ErrorCode>int</ErrorCode>
<Message>string</Message>
<ResultData>
<xsd:schema>schema</xsd:schema>xml</ResultData>
</Forms_by_GroupIDsResult>
</Forms_by_GroupIDsResponse>
</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

Length

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!

  • No labels

For help regarding Quik! Forms and the Quik! API
Email: support@quikforms.com | Phone: (877) 456-QUIK