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.
...
All Quik! web services have been architected 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
| Code Block | ||||
|---|---|---|---|---|
| ||||
<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 – customerCustomer's Quik! username
- Password – customerCustomer's Quik! password
SOAP BODY
| Code Block | ||||
|---|---|---|---|---|
| ||||
"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
| Code Block | ||||
|---|---|---|---|---|
| ||||
<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:
...