This document outlines the technical requirements for vendors to integrate with an OEM's lead distribution and disposition reporting system. It describes the three methods by which leads will be sent from the OEM to vendors: email with an XML attachment, a SOAP/XML web service, or an HTTP POST. It also provides details on how vendors should report lead status information back to the OEM using a web service or HTTP POST with an XML payload. Response codes are defined to indicate success or error for both the lead and status submission processes.
1. OEM LEAD DISPOSITION REPORTING SOLUTION
OEM Lead Referral Management Application Certification
Technical Architecture Design Document - Version 3.3
(Updated May 7, 2003)
Assembled, Edited and Revised by:
Ralph Paglia
ralph_paglia@adp.com
505-301-6369
2. OEM LEAD DISPOSITION REPORTING SOLUTION
Certification Criteria Requirement
1. To Vendors
Leads will be sent from OEM Lead Distribution System in one of three ways:
Repository
Web Service Email
/ POST
ADF/XML ADF/XML
{}
{}
Vendor Application
{}
Figure 1
Email (XML -- Lead Data ADF XML v1.0)
Web Services
HTTP POST
Lead Disposition Reporting Technical Document Page 1 of 9 OEM Application Certification Requirements
3. OEM LEAD DISPOSITION REPORTING SOLUTION
Email (XML -- Lead Data ADF XML v1.0)
The current standard for lead submission being supported is XML - Lead Data ADF XML v1.0.
The following are the OEM standards for email submission:
1. “From:” field will contain OEM’s distribution system email
2. “To:” field will be based on routing information
3. “Subject:” will contain “OEM Lead”
4. “Body:” will contain an ADF XML in plain text format
A simple example:
To: vendorA@vendorsdomain.com
From: LDRAemail@ebizmail.OEM.com
Subject: OEM Lead
Body:
ADF Formatted Data
Lead Disposition Reporting Technical Document Page 2 of 9 OEM Application Certification Requirements
4. OEM LEAD DISPOSITION REPORTING SOLUTION
Web Service
POST /Vendor/Service1.asp HTTP/1.1
Host: vendor.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://OEM.com/webservice/NewLead"
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-
instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<NewLead xmlns="http://tempuri.org/">
<adfData>string</adfData>
</NewLead>
</soap:Body>
</soap:Envelope>
Field Description
adfData ADF formatted lead information being submitted
Expected Response
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-
instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<NewLeadResponse xmlns="http://tempuri.org/">
<NewLeadResult>int</NewLeadResult>
</NewLeadResponse>
</soap:Body>
</soap:Envelope>
Field Description
NewLeadResult 0 – Successful
1 – Failed schema validation
2 – Missing information; etc.
Lead Disposition Reporting Technical Document Page 3 of 9 OEM Application Certification Requirements
5. OEM LEAD DISPOSITION REPORTING SOLUTION
HTTP POST
POST /OEM.com/webservice/newLead.asp HTTP/1.1
Host: OEM.com
Content-Type: text/xml
Content-Length: length
string
Field Description
string ADF formatted lead information being submitted
Expected Response
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<retCode>int</retCode>
Type Description
int 0 – Successful
1 – Failed schema validation
2 – Bad/Missing information; etc.
Lead Disposition Reporting Technical Document Page 4 of 9 OEM Application Certification Requirements
6. OEM LEAD DISPOSITION REPORTING SOLUTION
2. From Vendors – lead status information
Status information coming from the vendor should be submitted to OEM’s web service/method.
The information can be submitted using an HTTP POST, or by a direct call to the web
service/method using SOAP/XML. The web service URL will be provided after a vendor’s
certification process has been completed.
OEM
Figure 2
A simple example (Web Service):
http://ldra.OEM.com/programs/inc/rra08adf.wsdl
POST http://ldra.OEM.com/programs/asp/rra08wsh.asp HTTP/1.1
Host: ldra.OEM.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "LeadStatus"
<?xml version="1.0" encoding="utf-8"?>
Lead Disposition Reporting Technical Document Page 5 of 9 OEM Application Certification Requirements
7. OEM LEAD DISPOSITION REPORTING SOLUTION
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-
instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<statusData>string</statusData>
</soap:Body>
</soap:Envelope>
Ex. <statusData>
<status>
<lead> <!-- Repeat for additional lead status -->
<id>string</id>
<arrivaltime>string</arrivaltime>
<autoresponse>Boolean (0 or 1)</autoresponse>
<responsetime>string</responsetime>
<lastevent>int</lastevent>
<currentstatus>int</currentstatus>
</lead>
</status>
Field Description
id A unique lead id provided by OEM. This will be
used to identify the lead when returning lead
submission status information.
arrivaltime The date/time the lead arrived
autoresponse True - 1/False - 0 if an auto response was sent to
the customer on arrival
responsetime The date/time the lead was acted upon.
lastevent Last event on lead:
1 – Sale
2 – Meeting
3 – Letter
4 – Phone
5 – Note
6 – Inactive
7 – Email
currentstatus 1 – <Reserved>
2 – In Process (Any activity taken on lead)
3 – Sold
4 – Inactive
Lead Disposition Reporting Technical Document Page 6 of 9 OEM Application Certification Requirements
8. OEM LEAD DISPOSITION REPORTING SOLUTION
Response
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-
instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<LeadStatusResponse xmlns="http://tempuri.org/">
<LeadStatusResult>int</NewLeadResult>
</LeadStatusResponse>
</soap:Body>
</soap:Envelope>
Field Description
LeadStatusResult 0 – Successful
1 – Failed schema validation
2 – Bad/Missing information; etc.
Lead Disposition Reporting Technical Document Page 7 of 9 OEM Application Certification Requirements
9. OEM LEAD DISPOSITION REPORTING SOLUTION
HTTP POST
http://ldra.OEM.com/programs/asp/rra08vls.asp
Content-Type: text/xml
Content-Length: length
string
<status>
<lead> <!-- Repeat for additional lead status -->
<id>string</id>
<arrivaltime>string</arrivaltime>
<autoresponse>Boolean (0 or 1)</autoresponse>
<responsetime>string</responsetime>
<lastevent>int</lastevent>
<currentstatus>int</currentstatus>
</lead>
</status>
Field Description
id A unique lead id provided by OEM. This will be
used to identify the lead when returning lead
submission status information.
arrivaltime The date/time the lead arrived
autoresponse True – 1 /False - 0 if an auto response was sent to
the customer on arrival
responsetime The date/time the lead was acted upon.
lastevent Last event on lead:
1 – Sale
2 – Meeting
3 – Letter
4 – Phone
5 – Note
6 – Inactive
7 – Email
currentstatus 1 – <Reserved>
2 – In Process (Any activity taken on lead)
3 – Sold
4 – Inactive
Lead Disposition Reporting Technical Document Page 8 of 9 OEM Application Certification Requirements
10. OEM LEAD DISPOSITION REPORTING SOLUTION
Expected Response
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<retCode>int</retCode>
Type Description
int 0 – Successful
1 – Failed schema validation
2 – Bad/Missing information; etc.
Lead Disposition Reporting Technical Document Page 9 of 9 OEM Application Certification Requirements