SOAP 1.2 Web Service
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 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).
Destination Details
Column Mapping
API Specification
Filter
The following parameters will help to define your data sync destination and how it functions.
Parameter | Description | Example |
|---|---|---|
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.
Parameter | Description | Example |
|---|---|---|
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.
Parameter | Description | Example |
|---|---|---|
Endpoint URL | ||
This is required to be true if the SOAP API response contains an attachment outside of the SOAP response message. See this diagram for more information. | | |
Envelope Namespace | The namespace prefix to use for the SOAP request elements.
This value will default to "soapenv" as associated with the following schema: https://schemas.xmlsoap.org/soap/envelope/
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. <foo:Envelope xmlns:foo="..."> <foo:Body> [Request XML] </foo:Body> </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", however you can delete this value andor add additional values, as needed.
This value appears 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.
By default, the Connections UI will populate this field with "http://schemas.xmlsoap.org/soap/envelope/", however you can delete this value andor add additional values, as needed.
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> |
Request Header
SOAP Body
Parameter | Description | Example |
|---|---|---|
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 xmlns="http://www.dataaccess.com/webservicesserver/"> <ubiNum>500</ubiNum> </NumberToWords> |
Variables to Extract
You may choose to specify variables to extract from your SOAP response.
Parameter | Description | Example |
|---|---|---|
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.
Image 2: Define your Destination
- Define your Sync Behaviour. Note that if you are doing a Full-File sync, the API Specification > SOAP 1.2 Source section should be filled in.
- If you are running a batch sync, click Jobs > Start a Job to begin your sync.
Last modified 3mo ago