XML Integration - ActiveProspect

XML Integration

PRICING

Standard Transactional Pricing

VERSION

1.0.4

ADDITIONAL INFO

XML Website

Overview

A widely used semi-structured format for data using tags and text to define data and structure. Accepts JSON, XML, HTML, or text responses.

Appended Fields

ActiveProspect will append the following data to your lead.

Appended FieldDescription
Outcome
The outcome of the transaction (default is success)
Reason
If the outcome was a failure, this is the reason
Cookie
The full cookie header string captured via match with 'cookie_search_term'
Price
The price of the lead
Reference
The reference ID of the lead
*

Custom Input Variables

The following are configuration options (typically not collected with lead data).

VariableDescription
UrlServer URL
MethodHTTP method (POST, PUT, or PATCH)
Basic UsernameHTTP Basic Authentication user name
Basic PasswordHTTP Basic Authentication password
Xml Path XML path in dot notation
Xml ParameterTo "stuff" the XML into a parameter and send as Form URL encoded, specify the parameter name
Extra Parameter Extra parameters to include in URL, only used when XML Parameter is set
Outcome Search TermThe 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 PathNarrow the search scope using dot-notation path (for JSON responses), XPath (for XML responses), or CSS selector (for HTML responses)
Outcome On MatchThe outcome when the search term is found - "success" or "failure" or "error" (default: success)
Reason PathThe dot-notation path (for JSON responses), XPath location (for XML responses), or regular expression with a single capture group, used to find the failure reason
Price PathThe 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
Fallback PriceThe fallback price to use if the price_path fails to parse a price from the response.
Reference PathThe 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 ReasonFailure reason when no reason can be found per the optional Reason Path setting
Header HTTP header to send in the request
Send AsciiSet to true to ensure lead data is sent as ASCII for legacy recipients (default: false)
Capture A named regular expression with a single capture group, used to capture values from plain text responses into the named property
Response Content Type OverrideOverride response's Content-Type header with custom value.
Cookie Search TermThe text to search for to identify an HTTP cookie. Usually the cookie 'name' is sufficient; regular expressions are allowed
Follow RedirectsIf true, follow redirects even on methods other than GET (default: false)
Timeout SecondsProduce an "error" outcome if the server fails to respond within this number of seconds (default: 360)