SOAP 1.2 web service
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.
Info tab
You can find the parameters in the Info tab below (Image 1).
Values
Parameter | Description | Example |
---|---|---|
Title | Mandatory. Input a name for your data sync | SOAP Sync |
Variables | Optional. Review our documentation on Variables here for more information about this field. | |
Permissions | Data syncs are role based access systems where you can give specific groups read, write, execute, and/or all of the above with admin access. Inputting at least an Admin Group is mandatory. |
Source tab
The following table outlines the mandatory and optional parameters you will find on the Source tab (Image 2).
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. | |
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" |
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:" | "soap" |
Namespaces - Value | The URL describing this namespace in the response. In the below snippet this value is "http://www.dataaccess.com/webservicesserver/" |
Next steps
Configure your Destination
Define your Sync Actions.
Add in your Post Sync Scripts, if required.
Click Jobs > Start a Job to begin your sync.
Namespace Value
Last updated