SOAP 1.2 Web Service

1. Overview
SOAP (Simple Object Access Protocol) is an XML-based protocol for accessing web services over HTTP.
SOAP allows applications running on different operating systems to communicate using different technologies and programming languages. You can use SOAP APIs to create, retrieve, update or delete records, such as passwords, accounts, leads, and custom objects, from a server.
The SOAP 1.2 Web Service source supports batch syncs.
2. Info Tab
You can review the parameters that can be found in the info tab below (Image 1).
Values
Parameter
Description
Example
Title
Mandatory. Input a name for your data sync
SOAP Sync
Version
Mandatory. This is a pre-populated field containing a version number for your data sync. You can override it if you wish.
1.0.0
Parameters
Optional. Review our documentation on Parameters here for more information about this field.
​
Image 1: The Info Tab
3. Source Tab
The following table outlines the mandatory and optional parameters you will find on the Source tab (Image 2).
Source Details
Schema
The following parameters will help to define your data sync source and how it functions.
Parameter
Description
Example
Source
Mandatory. Select your source from the drop down menu.
SOAP 1.2 Web Service
authType
Mandatory. Select the type of authentication you wish to us in this sync.
- None
- WSSE: This will allow you to use a Username and Password to authenticate via a WS-Security SOAP envelope header.
- Basic: This will allow you to use a Username and Password to authenticate via a basic auth header.
Basic
Use Password Digest
The password digest is a cryptographic hash of the password and timestamp. This parameter should only be used in conjunction with a WSSE authType, and when the Password Type for your auth is "PasswordDigest". If neither of those applies, leave this value unchecked.
​
Request Timeout
Mandatory. You can use this field to set a timeout, in milliseconds, for your request. There is no maximum value. The minimum should be greater than 0. The default value is 100 milliseconds
2000
Endpoint
Mandatory. This field should contain your SOAP 1.2 Web Service API endpoint.
​dataaccess​
Has Mtom Response
This value is required to be true if: the SOAP API response contains an attachment outside of the response message. See here for an example.​
​
Record Xpath
Mandatory. The Xpath to select all records we want to extract from the SOAP response. The path should point to the XML element wrapping the column data.

XPath stands for XML Path Language. It uses a non-XML syntax to provide a flexible way of addressing (pointing to) different parts of an XML document. This value should start with ‘//’ and be followed by the tag name of the data. 

You can refer http://xpather.com/ to find out the Xpath.
​
Envelope Namespace
The namespace prefix to use for the SOAP request elements.

For example, setting the value to "foo" would result in the soap request being prefixed with the "foo" namespace. 
​
​
<foo:Envelope xmlns:foo="...">
	<foo:Body>
		[Request XML]
	</foo:Body>
</foo:Envelope>
"foo"
Namespaces - Name
The name of your SOAP namespace tags in your request and response. This value appear as "soap" in the snippet below.
​
These should be the values immediately after "xmlns:"

<?xml version="1.0" encoding="utf-8"?>
<soapenv:Envelope
	xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
	<soap:Body>
		<m:NumberToWordsResponse
			xmlns:m="http://www.dataaccess.com/webservicesserver/">
			<m:NumberToWordsResult>four million four hundred and seventy three thousand two hundred and thirty nine </m:NumberToWordsResult>
		</m:NumberToWordsResponse>
	</soap:Body>
</soap:Envelope>
"soap"
Namespaces - Value
The URL describing this namespace in the response. In the below snippet this value is "http://www.dataaccess.com/webservicesserver/"

<?xml version="1.0" encoding="utf-8"?>
<soapenv:Envelope
	xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
	<soap:Body>
		<m:NumberToWordsResponse
			xmlns:m="http://www.dataaccess.com/webservicesserver/">
			<m:NumberToWordsResult>four million four hundred and seventy three thousand two hundred and thirty nine </m:NumberToWordsResult>
		</m:NumberToWordsResponse>
	</soap:Body>
</soapenv:Envelope>
​
"http://www.dataaccess.com/webservicesserver/"
​
The Schema section is where you define which source columns you want to sync in your connection. You can repeat the values for multiple columns.
Parameter
Description
Example
Name
Mandatory. The name of your column as it appears in the source.
Name
Alias
Optional. You may choose to use an alias on your column so that it has a different name in the data sync.
​
Data Type
Mandatory. The data type of the column values. 
Text
Description
Optional. You may choose to add a description to your column.
​
​
There are other options available for the Schema section if you click on Show Advanced.
Parameter
Description
Example
Mandatory
If both Mandatory and Validated are checked on a column, then rows where the column is empty are rejected
If just Mandatory is checked on a column, then all rows are synced with the execution log status of failed, and the source error of "Mandatory Rule Violation"
If just Validated is checked on a column, then all rows are synced.
​
Validate Data
If both Mandatory and Validated are checked on a column, then rows where the column is empty are rejected
If just Validated is checked on a column, then all rows are synced.
​
Trim Whitespace
Optional if data type = text.  If your data type was chosen as "text", you can choose whether to trim the whitespace (that is, spaces and other non-printing characters).
​
Max Length
Optional if data type = text. You can input a numerical value in this field that represents the maximum length of the data that can be synced in your column. If the value is exceeded, the row will be rejected (you can find this error in the Execution Log).
​
You can choose to add in a Transformation > String Replacement by inputting the following:
Parameter
Description
Example
Pattern
Mandatory if using a Transformation. The pattern for your string replacement, i.e. the string that will be searched and replaced.
​
Replacement
What you want to replace your pattern with.
​
Note that you can have more than one String Replacement
​
Image 2: The Source Tab
4. Next Steps
Configure your Destination​
Define your Sync Behaviour.
Add in your Post Sync Scripts, if required.
Define your Permissions.
Click Jobs > Start a Job to begin your sync.

Parameter	Description	Example
Title	Mandatory. Input a name for your data sync	SOAP Sync
Version	Mandatory. This is a pre-populated field containing a version number for your data sync. You can override it if you wish.	1.0.0
Parameters	Optional. Review our documentation on Parameters here for more information about this field.

Parameter	Description	Example
Source	Mandatory. Select your source from the drop down menu.	SOAP 1.2 Web Service
authType	Mandatory. Select the type of authentication you wish to us in this sync. - None - WSSE: This will allow you to use a Username and Password to authenticate via a WS-Security SOAP envelope header. - Basic: This will allow you to use a Username and Password to authenticate via a basic auth header.	Basic
Use Password Digest	The password digest is a cryptographic hash of the password and timestamp. This parameter should only be used in conjunction with a WSSE authType, and when the Password Type for your auth is "PasswordDigest". If neither of those applies, leave this value unchecked.
Request Timeout	Mandatory. You can use this field to set a timeout, in milliseconds, for your request. There is no maximum value. The minimum should be greater than 0. The default value is 100 milliseconds	2000
Endpoint	Mandatory. This field should contain your SOAP 1.2 Web Service API endpoint.	dataaccess
Has Mtom Response	This value is required to be true if: the SOAP API response contains an attachment outside of the response message. See here for an example.
Record Xpath	Mandatory. The Xpath to select all records we want to extract from the SOAP response. The path should point to the XML element wrapping the column data. XPath stands for XML Path Language. It uses a non-XML syntax to provide a flexible way of addressing (pointing to) different parts of an XML document. This value should start with ‘//’ and be followed by the tag name of the data. You can refer http://xpather.com/ to find out the Xpath.
Envelope Namespace	The namespace prefix to use for the SOAP request elements. For example, setting the value to "foo" would result in the soap request being prefixed with the "foo" namespace. <foo:Envelope xmlns:foo="..."> <foo:Body> [Request XML] </foo:Body> </foo:Envelope>	"foo"
Namespaces - Name	The name of your SOAP namespace tags in your request and response. This value appear as "soap" in the snippet below. These should be the values immediately after "xmlns:" <?xml version="1.0" encoding="utf-8"?> <soapenv:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <m:NumberToWordsResponse xmlns:m="http://www.dataaccess.com/webservicesserver/"> <m:NumberToWordsResult>four million four hundred and seventy three thousand two hundred and thirty nine </m:NumberToWordsResult> </m:NumberToWordsResponse> </soap:Body> </soap:Envelope>	"soap"
Namespaces - Value	The URL describing this namespace in the response. In the below snippet this value is "http://www.dataaccess.com/webservicesserver/" <?xml version="1.0" encoding="utf-8"?> <soapenv:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <m:NumberToWordsResponse xmlns:m="http://www.dataaccess.com/webservicesserver/"> <m:NumberToWordsResult>four million four hundred and seventy three thousand two hundred and thirty nine </m:NumberToWordsResult> </m:NumberToWordsResponse> </soap:Body> </soapenv:Envelope>	"http://www.dataaccess.com/webservicesserver/"

Parameter	Description	Example
Name	Mandatory. The name of your column as it appears in the source.	Name
Alias	Optional. You may choose to use an alias on your column so that it has a different name in the data sync.
Data Type	Mandatory. The data type of the column values.	Text
Description	Optional. You may choose to add a description to your column.

Parameter	Description	Example
Mandatory	If both Mandatory and Validated are checked on a column, then rows where the column is empty are rejected If just Mandatory is checked on a column, then all rows are synced with the execution log status of failed, and the source error of "Mandatory Rule Violation" If just Validated is checked on a column, then all rows are synced.
Validate Data	If both Mandatory and Validated are checked on a column, then rows where the column is empty are rejected If just Validated is checked on a column, then all rows are synced.
Trim Whitespace	Optional if data type = text. If your data type was chosen as "text", you can choose whether to trim the whitespace (that is, spaces and other non-printing characters).
Max Length	Optional if data type = text. You can input a numerical value in this field that represents the maximum length of the data that can be synced in your column. If the value is exceeded, the row will be rejected (you can find this error in the Execution Log).

Parameter	Description	Example
Pattern	Mandatory if using a Transformation. The pattern for your string replacement, i.e. the string that will be searched and replaced.
Replacement	What you want to replace your pattern with.

Last modified 3mo ago