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.

This section describes the general format of all Quik! SOAP web service requests and responses. For detailed information about each web service method, please read the detailed section for each method.

Request Format

All Quik! web services have been built in the same manner, and each call to a web service method will be similar. Requests should be made using 128-bit+ SSL encryption. Each method requires the following request format:

SOAP HEADER

<soap12:Header>
 <AuthenticationHeader xmlns="https://websvcs.quikforms.com/QFEM/v5100/">
 <CustomerID>string</CustomerID>
 <UserName>string</UserName>
 <Password>string</Password>
 </AuthenticationHeader>
</soap12:Header>  

SOAP Header Parameters
Note: Only a customer's Master Credentials are to be used when calling Quik! APIs (not end-user credentials)

• CustomerID – ID assigned in Quik! database for the customer account
• UserName – Customer's Quik! username
• Password – Customer's Quik! password

SOAP BODY

"METHOD_NAME" below is the method being called; input parameters vary.
<soap12:Body>
 <METHOD_NAME xmlns="https://websvcs.quikforms.com/QFEM/v5100">
 <PARAM_1>string</PARAM_1>
 <PARAM_2>string</PARAM_2>
 <PARAM_3>string</PARAM_3>
 </soap12:Body> 

Response Format

Each Quik! web service will respond in a similar fashion. The response will only return a SOAP Body containing the response as follows:

SOAP BODY

<soap12:Body>
 <METHOD_NAME xmlns="https://websvcs.quikforms.com/QFEM/v5100">
 <METHOD_NAMEResult>
  <ErrorCode>int</ErrorCode>
  <Message>string</Message>
  <ResultData>
  <xsd:schema>schema</xsd:schema>xml</ResultData>
  <File>base64Binary</File>
 </METHOD_NAMEResult>
 </METHOD_NAME>
</soap12:Body> 

Each response will contain the following fields:

• ErrorCode – an integer response code between 0 and 999 corresponding to the type of success or failure (0 = success).

• Message – a string message providing details about the response, including both success and error messages.
• ResultData (not applicable to all responses) – If the type of request made returns a set or list of data (e.g. a list of users, forms, etc.), the QuikData element will contain an XML data set. For details about each detailed XML data set, please see the detailed method information. NOTE: To use the returned data, store the data in a XML Document object and use accordingly.
• File – If a file is returned (e.g. a PDF) the file will be encoded in binary 64 format.