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.
Before you set up your data sync destination, make sure to configure your Source.
The SOAP 1.2 Web Service destination supports batch and real-time syncs.
The following table outlines the mandatory and optional parameters you will find on the Destination tab (Image 1).
The following parameters will help to define your data sync destination and how it functions.
Destination
Mandatory. Select your destination from the drop down menu.
SOAP 1.2 Web Service
The Column Mapping section is where you define which source columns you want to sync to which destination columns. You can repeat the values for multiple columns. When specifying the Target Column in the Column Mappings section, all names are case-sensitive.
Source Column
Mandatory. The name of your column as it appears in the source.
Name
Target Column
Mandatory. The name of your column as it appears in the destination.
Name
The API Specification section will default with a mandatory Insert Specification field, however you are also able to add fields for Request Headers, SOAP Body, and Variables to Extract. Insert Specification When specifying the Target Column in the Column Mappings section, all names are case-sensitive.
Endpoint URL
Envelope Namespace
/foo:Envelope | soapenv | | Namespace - Name |
The name of your SOAP namespace tags in your request and response.
By default, the Connections UI will populate this field with soapenv, but you can delete this value or add additional values, as needed.
This value appears 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. By default, the Connections UI will populate this field with http://schemas.xmlsoap.org/soap/envelope/, however you can delete this value or add additional values, as needed. In the below snippet this value is "http://www.dataaccess.com/webservicesserver/"\
| "http://www.dataaccess.com/webservicesserver/" |
Request Header
You can add in Request Headers by reviewing the documentation here.
SOAP Body
XML
The SOAP body is a sub-element of the SOAP envelope, which contains information intended for the ultimate recipient of the message. This field is expecting you to specify the SOAP Body.
/NumberToWords> |
Variables to Extract
You may choose to specify variables to extract from your SOAP response.
Name
The name of the variable you wish to extract.
Value
Path in Response
The path to the above variable.
soapenv:Envelope/soapenv:Body/m:NumberToWordsResponse/m:NumberToWordsResult[1]
SOAP 1.2 Source
This section should be used if you have a set of data from a SOAP API that you need to reconcile against; therefore it should always be used when doing Full-File syncs. You can follow the values outlined on this page to set up this section.
You have the option to add a destination filter to your data sync. Please review the documentation here for more information on destination filters.
## Next steps
Define your Sync Actions. Note that if you are doing a Full-File sync, the API Specification > SOAP 1.2 Source section should be filled in.
Add in your Post Sync Scripts, if required.
Define your Permissions.
If you are running a real-time sync, set up your Listener Config and enable it to begin your sync.
If you are running a batch sync, click Jobs > Start a Job to begin your sync.
Namespace Value
Mandatory. The URL of the
Has
This is required to be true if the SOAP API response contains an attachment outside of the SOAP response message.
The namespace prefix to use for the SOAP request elements.
This value will default to soapenv as associated with the following schema:
You can append the default value, if you wish. For example, setting the value to "foo" would result in the soap request being prefixed with the "foo" namespace.