SOAP Integration
Overview
A message-based protocol based on XML for accessing services on the Web.
Appended Fields
ActiveProspect will append the following data to your lead.
| Appended Field | Description |
|---|---|
Outcome | The outcome of the SOAP transaction (default is success) |
Reason | If the outcome was a failure, this is the reason |
Price | The price of the lead |
* |
Custom Input Variables
The following are configuration options (typically not collected with lead data).
| Variable | Description |
|---|---|
| Url | WSDL URL |
| Function | Name of the SOAP function to call |
| Version | SOAP version to use: 1.1 or 1.2 (default: 1.1) |
| Basic Username | HTTP Basic Authentication user name |
| Basic Password | HTTP Basic Authentication password |
| Bearer Token | HTTP Bearer Token |
| Wss Username | WS Security user name |
| Wss Password | WS Security password |
| Wss Digest Password | Digest the WS Password (default: true) |
| Arg | Named function argument |
| Outcome Search Term | The text to search for in the response. When found outcome will be "success". Regular expressions are allowed. Pro tip: Use Outcome on Match to use this term to search for "failure" instead of "success". |
| Outcome Search Path | Narrow the search scope using dot-notation path |
| Outcome On Match | The outcome when the search term is found - "success" or "failure" (default: success) |
| Reason Path | The dot-notation path used to find the failure reason |
| Price Path | The dot-notation path (for JSON responses), XPath location (for XML responses), or regular expression with a single capture group, used to find the lead price |
| Reference Path | The dot-notation path (for JSON responses), XPath location (for XML responses), or regular expression with a single capture group, used to find the reference ID |
| Default Reason | Failure reason when no reason can be found per the optional Reason Path setting |
| Soap Header | Custom SOAP header in the format root_name.header_name or root_name@xmlns |
| Send Ascii | Set to true to ensure lead data is sent as ASCII for legacy recipients (default: false) |
| Root Namespace Prefix | namespace prefix for the body element |
| Root Xmlns Attribute Name | xmlns namespace attribute name for the body element |
| Root Xmlns Attribute Value | xmlns namespace attribute value for the body element |
| Timeout Seconds | Produce an "error" outcome if the server fails to respond within this number of seconds (default: 360) |