everlogic connectnow interface · everlogic connectnow interface 3 of 12 last updated: january 11,...

Information contained in this document is private and confidential. This document contains information sensitive to the strategic positioning of EverLogic, Inc. and is considered a trade secret of EverLogic, Inc.. By reviewing and/or using the information contained in this document you agree not to use this information to compete with EverLogic, Inc. or to provide information contained in this document to unauthorized readers, competitors, or potential competitors of EverLogic, Inc..

EverLogic ConnectNOW Interface 1 of 12 Last Updated: January 11, 2016

SPECIFICATIONS & GUIDELINES FOR

EverLogic ConnectNOW Interface

Version 1.0



Contents

CHANGE LOG .............................................................................................................................................................................. 3

DOCUMENT OVERVIEW .............................................................................................................................................................. 4

INTENDED AUDIENCE.................................................................................................................................................................. 4

INTERFACE SPECIFICATIONS........................................................................................................................................................ 5

WEB SERVICE LOCATION ....................................................................................................................................................................... 5 INPUT SPECIFICATIONS ......................................................................................................................................................................... 5 OUTPUT SPECIFICATIONS ...................................................................................................................................................................... 7

Standard Response ..................................................................................................................................................................... 7 Error Response ........................................................................................................................................................................... 8

APPENDIX A – SAMPLE INPUT ................................................................................................................................................................ 9 APPENDIX B – SAMPLE OUTPUT ........................................................................................................................................................... 10 APPENDIX C – TABLE VALUES .............................................................................................................................................................. 11 APPENDIX D – EXAMPLES OF CONSUMING THE WEB SERVICE ...................................................................................................................... 12

Classic ASP ................................................................................................................................................................................ 12 ASP.NET .................................................................................................................................................................................... 12



Change Log

Date By Description

2009-04-20 C. Lineberger Created Document

2011-07-29 C. Lineberger Updated for ConnectNOW features

2012-04-02 C. Lineberger Updated to EverLogic naming



Document Overview

This document outlines the interfaces that have been designed as a communications gateway between an external

system such as a web site and the EverLogic Dealership Management System’s Customer/Prospecting module. The purpose of this interface is to provide a standard mechanism to capture customer requests from an external system. The interface is designed to allow for the capture of many different types of requests from simple ‘contact us’ forms to complex ‘request quotes’ or ‘order parts’ forms. All Communication is performed via HTTP Web Services by passing Xml formatted data.

Intended Audience

The intended audience of this specification are software developers with a working knowledge of SOAP based web

services and Xml document format. Readers are assumed to have a general understanding of web services and how to consume them. The service is written in .NET, but any language that can consume a SOAP based web service can be used.



Interface Specifications

Web Service Location

The web service is located at the URL webservices.everlogic.com. The full path is http://webservices.everlogic.com/Webservices.Pub/Prospect.asmx. The web method to be called is

SetProspect(UpdateData As String). The web method accepts a string parameter that is Xml formatted as defined in the Input Specifications below.

Input Specifications

The EverLogic ConnectNOW web service requires that you send in your authentication credentials and the collected

prospect information. The authentication credentials are provided by EverLogic and are not the same as the user login credentials used to sign on to the EverLogic DMS application.

Format of Input Xml

<?xml version="1.0" encoding="utf-8" ?>

<ConnectNOW>

<Credentials>

<DealerName>YourDealerName</DealerName>

<DealerId>YourDealerId</DealerId>

<DealerPass>YourDealerPass</DealerPass>

</Credentials>

<ProspectData>

<FirstName></FirstName>

<LastName></LastName>

<Address></Address>

<City></City>

<State></State>

<Zip></Zip>

<Email></Email>

<HomePhone></HomePhone>

<MobilePhone></MobilePhone>

<WorkPhone></WorkPhone>

<Comments></Comments>

<TimeFrame></TimeFrame>

<VehicleType></VehicleType>

<LeadSource></LeadSource>

<TrafficType></TrafficType>

<InputType></InputType>

</ProspectData>

</ConnectNOW>

In the above example the 'YourDealer...' would be replaced with the credentials provided by EverLogic.

Field Definitions

http://webservices.everlogic.com/Webservices.Pub/Prospect.asmx



Attribute Name Description Type Validation Prospect Information

FirstName First Name Text Free (First or Last required)

LastName Last Name Text Free (First or Last required)

Address Address Text Free

City City Text Free

State State Text Free

Zip Zip Text Free

Email Email Text Free (Email or Phone required)

HomePhone Home Phone Text 999-999-9999 (Email or Phone required)

MobilePhone Mobile Phone Text 999-999-9999 (Email or Phone required)

WorkPhone Work Phone Text 999-999-9999 (Email or Phone required)

Comments Comments or Notes Text Free

TimeFrame Timeframe of decision Number Table A (Appendix C)

StockNmber Stock Number of Vehicle Text Optional (Only used in 101, 108 types)

InputType Type of form submitted Number Table B (Appendix C)



Output Specifications

Standard Response

A standard response is returned when all validation of credentials and Xml is passed and the web service returns data from the database.

Format of Standard Response

<ConnectNOW>

</ConnectNOW>

Field Definitions

Attribute Name Description Type Validation

Id Response ID Number None



Error Response

An Error Response is returned any time the validation of credentials or of the Xml document passed to the web service fails. The format of the Error Response is the same for all errors. The <Error> Xml Node will define the current error(s)

Format of Error Response

<ConnectNOW>

<Errors>

<Error></Error>

</Errors>

</ConnectNOW>

Error Messages Definitions

Return Error Message Reason Corrective Action

There is a problem with your Credentials, please verify and try again.

The login credentials are either not provided or are not in the correct format.

Provide all three (3) login credentials in the format specification.

Your Credentials could not be validated, please verify and try again.

The login credentials were provided and were parsed, but could not be validated.

Provide the correct login credentials.

Your search criteria appears to be missing or in the wrong format.

The search request you have passed cannot be parsed by the web service.

Provide the search criteria in the format specification.



Appendixes

Appendix A – Sample Input

Example of INPUT

<?xml version="1.0" encoding="utf-8" ?>

<ConnectNOW>

<Credentials>

<DealerName>EverLogic Motors</DealerName>

<DealerId>12345</DealerId>

<DealerPass>PASSWORD</DealerPass>

</Credentials>

</ConnectNOW>

In the above examples the credentials used are for example only and will not allow access to the EverLogic

ConnectNOW web services. These values should be replaced with the credentials provided by EverLogic.



Appendix B – Sample Output

Standard Response

<ConnectNOW>

</ConnectNOW>

Error Response

Incorrect user credentials are passed to the web service

<ConnectNOW>

<Errors>

<Error>Your Credentials could not be validated, please verify and try again.</Error>

</Errors>

</ConnectNOW>

Formatting or validation problem with prospect information

<ConnectNOW>

<Errors>

<Error>At least one Name is required. Please enter a First or Last Name.</Error>

</Errors>

</ConnectNOW>



Appendix C – Table Values

Table A. Decision Timeframe

ID Name

-1 Not Entered / Nothing

1 Unknown

2 Now

3 Within 30 Days

4 30-60 Days

5 Within 3 Months

6 Within 6 Months

7 Within 12 Months

Table B. Type of Request

Code Name

100 General Request

101 Sales Quote

102 Consignment

103 Parts Inquiry

104 Service Appointment

105 Financing

106 Insurance

107 Warranty

108 Make Offer



Appendix D – Examples of consuming the web service

Classic ASP

Future Use

ASP.NET

Future Use

everlogic connectnow interface · everlogic connectnow interface 3 of 12 last updated: january 11,...

Documents