You are on page 1of 10

OEM LEAD DISPOSITION REPORTING SOLUTION

OEM Lead Referral Management Application Certification Technical Architecture Design Document - Version 3.3

(Updated October 9, 2012)

Edited and Revised by:

Ralph Paglia Consulting Practice Leader Reynolds and Reynolds ralph_paglia@reyrey.com 505-301-6369

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 / POST

Email

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 2 of 9

OEM Application Certification Requirements

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 OEMs 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 3 of 9

OEM Application Certification Requirements

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/XMLSchemainstance" 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 adfData Expected Response


HTTP/1.1 200 OK

Description ADF formatted lead information being submitted

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/XMLSchemainstance" 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 NewLeadResult

Description 0 Successful 1 Failed schema validation 2 Missing information; etc.

Lead Disposition Reporting Technical Document

Page 4 of 9

OEM Application Certification Requirements

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 string Expected Response

Description ADF formatted lead information being submitted

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 int

Description 0 Successful 1 Failed schema validation 2 Bad/Missing information; etc.

Lead Disposition Reporting Technical Document

Page 5 of 9

OEM Application Certification Requirements

OEM LEAD DISPOSITION REPORTING SOLUTION


2. From Vendors lead status information
Status information coming from the vendor should be submitted to OEMs 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 vendors certification process has been completed.

{}

{} Vendor Application

{}

ADF /XML

W Service / eb HTTP PO ST

Personnel

Repository

O EM Lead Disposition Reporting

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 6 of 9

OEM Application Certification Requirements

OEM LEAD DISPOSITION REPORTING SOLUTION


<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchemainstance" 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 id arrivaltime autoresponse responsetime lastevent

Description A unique lead id provided by OEM. This will be used to identify the lead when returning lead submission status information. The date/time the lead arrived True - 1/False - 0 if an auto response was sent to the customer on arrival The date/time the lead was acted upon. 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 7 of 9

OEM Application Certification Requirements

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/XMLSchemainstance" 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 LeadStatusResult

Description 0 Successful 1 Failed schema validation 2 Bad/Missing information; etc.

Lead Disposition Reporting Technical Document

Page 8 of 9

OEM Application Certification Requirements

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 id arrivaltime autoresponse responsetime lastevent

Description A unique lead id provided by OEM. This will be used to identify the lead when returning lead submission status information. The date/time the lead arrived True 1 /False - 0 if an auto response was sent to the customer on arrival The date/time the lead was acted upon. 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 9 of 9

OEM Application Certification Requirements

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 int

Description 0 Successful 1 Failed schema validation 2 Bad/Missing information; etc.

Lead Disposition Reporting Technical Document

Page 10 of 9

OEM Application Certification Requirements

You might also like