Elead Product Reference Data

Status: Preview

Tier: Premium

Version: 1.0

Name

Summary

GetCompanyOpportunityStatuses (string client_id, string client_secret, string subscription_id, [Optional]string Accept, [Optional]string Accept-Charset, [Optional]string Accept-Encoding, [Optional]string Accept-Language, [Optional]string If-Match, [Optional]string If-None-Match, [Optional]string Prefer, string Request-Id)

Gets the opportunity statuses for the specified company

GetCompanyOpportunitySources ([Optional]string upType, string client_id, string client_secret, string subscription_id, [Optional]string Accept, [Optional]string Accept-Charset, [Optional]string Accept-Encoding, [Optional]string Accept-Language, [Optional]string If-Match, [Optional]string If-None-Match, [Optional]string Prefer, string Request-Id)

Gets the opportunity sources for the specified company and up types

GetOpportunitySubSources (string sourceName, string upType, string client_id, string client_secret, string subscription_id, [Optional]string Accept, [Optional]string Accept-Charset, [Optional]string Accept-Encoding, [Optional]string Accept-Language, [Optional]string If-Match, [Optional]string If-None-Match, [Optional]string Prefer, string Request-Id)

Retrieves the opportunity subsources for the specified source and up types

GetCompanySalesSteps (string client_id, string client_secret, string subscription_id, [Optional]string Accept, [Optional]string Accept-Charset, [Optional]string Accept-Encoding, [Optional]string Accept-Language, [Optional]string If-Match, [Optional]string If-None-Match, [Optional]string Prefer, string Request-Id)

Gets the sales steps for the specified company

GetCompanyPositions (string client_id, string client_secret, string subscription_id, [Optional]string Accept, [Optional]string Accept-Charset, [Optional]string Accept-Encoding, [Optional]string Accept-Language, [Optional]string If-Match, [Optional]string If-None-Match, [Optional]string Prefer, string Request-Id)

Gets the positions for the specified company

GetCompanyEmployees (string positionName, string client_id, string client_secret, string subscription_id, [Optional]string Accept, [Optional]string Accept-Charset, [Optional]string Accept-Encoding, [Optional]string Accept-Language, [Optional]string If-Match, [Optional]string If-None-Match, [Optional]string Prefer, string Request-Id)

Gets the employees for the specified company and position

GetCompanyEmails (string client_id, string client_secret, string subscription_id, [Optional]string Accept, [Optional]string Accept-Charset, [Optional]string Accept-Encoding, [Optional]string Accept-Language, [Optional]string If-Match, [Optional]string If-None-Match, [Optional]string Prefer, string Request-Id)

Gets the "from" email addresses for the specified company

GetVehicleClasses (string client_id, string client_secret, string subscription_id, [Optional]string Accept, [Optional]string Accept-Charset, [Optional]string Accept-Encoding, [Optional]string Accept-Language, [Optional]string If-Match, [Optional]string If-None-Match, [Optional]string Prefer, string Request-Id)

Gets the available vehicle class types

GetVehicleYears (string client_id, string client_secret, string subscription_id, [Optional]string Accept, [Optional]string Accept-Charset, [Optional]string Accept-Encoding, [Optional]string Accept-Language, [Optional]string If-Match, [Optional]string If-None-Match, [Optional]string Prefer, string Request-Id)

Gets the available vehicle years

GetVehicleMakes (integer year, [Optional]string class, string client_id, string client_secret, string subscription_id, [Optional]string Accept, [Optional]string Accept-Charset, [Optional]string Accept-Encoding, [Optional]string Accept-Language, [Optional]string If-Match, [Optional]string If-None-Match, [Optional]string Prefer, string Request-Id)

Gets the available vehicle makes by year and vehicle class (optional)

GetVehicleModels (integer year, string make, string client_id, string client_secret, string subscription_id, [Optional]string Accept, [Optional]string Accept-Charset, [Optional]string Accept-Encoding, [Optional]string Accept-Language, [Optional]string If-Match, [Optional]string If-None-Match, [Optional]string Prefer, string Request-Id)

Gets the available vehicle models by year and make

GetVehicleTrims (integer year, string make, string model, string client_id, string client_secret, string subscription_id, [Optional]string Accept, [Optional]string Accept-Charset, [Optional]string Accept-Encoding, [Optional]string Accept-Language, [Optional]string If-Match, [Optional]string If-None-Match, [Optional]string Prefer, string Request-Id)

Gets the available vehicle trims by year, make, and model

Name

Summary

Name

Summary

CompanyEmail

CompanyEmailCollection

CompanyEmployeeCollection

CompanyOpportunitySource

CompanyOpportunitySourceCollection

CompanyOpportunityStatus

CompanyOpportunityStatusCollection

CompanyOpportunitySubStatus

CompanyPosition

CompanyPositionCollection

CompanySalesStep

CompanySalesStepCollection

Employee

LinkDescriptionObject

OpportunitySubSource

OpportunitySubSourceCollection

VehicleClass

VehicleClassCollection

VehicleMake

VehicleMakeCollection

VehicleModel

VehicleModelCollection

VehicleTrim

VehicleTrimCollection

VehicleYear

VehicleYearCollection

Name

Type

Summary

Required

Related Action

client_id

string

(Client Id)

A client ID that should be unique to developer/solution provider building the solution.

True

client_secret

string

(Client Secret)

A client secret that should be unique to developer/solution provider building the solution.

True

subscription_id

string

(Subscription Id)

A correlation ID that should be returned back to the caller to indicate the return of the given request.

True

Accept

string

(Accept)

Accept Header

False

Accept-Charset

string

(Accept-Charset)

Accept-Charset Header

False

Accept-Encoding

string

(Accept-Encoding)

Accept-Encoding Header

False

Accept-Language

string

(Accept-Language)

Accept-Language Header

False

If-Match

string

(If-Match)

If-Match Header

False

If-None-Match

string

(If-None-Match)

If-None-Match Header

False

Prefer

string

(Prefer)Values: [return=representation, return=minimal]

Preference of the customer

False

Request-Id

string

(Request Id)

Format - guid. A correlation ID that should be returned back to the caller to indicate the return of the given request

True

Name

Type

Summary

Required

Related Action

upType

string

(Up Type)

The opportunity source up type

False

client_id

string

(Client Id)

A client ID that should be unique to developer/solution provider building the solution.

True

client_secret

string

(Client Secret)

A client secret that should be unique to developer/solution provider building the solution.

True

subscription_id

string

(Subscription Id)

A correlation ID that should be returned back to the caller to indicate the return of the given request.

True

Accept

string

(Accept)

Accept Header

False

Accept-Charset

string

(Accept-Charset)

Accept-Charset Header

False

Accept-Encoding

string

(Accept-Encoding)

Accept-Encoding Header

False

Accept-Language

string

(Accept-Language)

Accept-Language Header

False

If-Match

string

(If-Match)

If-Match Header

False

If-None-Match

string

(If-None-Match)

If-None-Match Header

False

Prefer

string

(Prefer)Values: [return=representation, return=minimal]

Preference of the customer

False

Request-Id

string

(Request Id)

Format - uuid.

True

Name

Type

Summary

Required

Related Action

sourceName

string

(Source Name)

The source name

True

upType

string

(Up Type)

The opportunity source up type

True

client_id

string

(Client Id)

A client ID that should be unique to developer/solution provider building the solution.

True

client_secret

string

(Client Secret)

A client secret that should be unique to developer/solution provider building the solution.

True

subscription_id

string

(Subscription Id)

A correlation ID that should be returned back to the caller to indicate the return of the given request.

True

Accept

string

(Accept)

Accept Header

False

Accept-Charset

string

(Accept-Charset)

Accept-Charset Header

False

Accept-Encoding

string

(Accept-Encoding)

Accept-Encoding Header

False

Accept-Language

string

(Accept-Language)

Accept-Language Header

False

If-Match

string

(If-Match)

If-Match Header

False

If-None-Match

string

(If-None-Match)

If-None-Match Header

False

Prefer

string

(Prefer)Values: [return=representation, return=minimal]

Preference of the customer

False

Request-Id

string

(Request Id)

Format - uuid.

True

Name

Type

Summary

Required

Related Action

client_id

string

(Client Id)

A client ID that should be unique to developer/solution provider building the solution.

True

client_secret

string

(Client Secret)

A client secret that should be unique to developer/solution provider building the solution.

True

subscription_id

string

(Subscription Id)

A correlation ID that should be returned back to the caller to indicate the return of the given request.

True

Accept

string

(Accept)

Accept Header

False

Accept-Charset

string

(Accept-Charset)

Accept-Charset Header

False

Accept-Encoding

string

(Accept-Encoding)

Accept-Encoding Header

False

Accept-Language

string

(Accept-Language)

Accept-Language Header

False

If-Match

string

(If-Match)

If-Match Header

False

If-None-Match

string

(If-None-Match)

If-None-Match Header

False

Prefer

string

(Prefer)Values: [return=representation, return=minimal]

Preference of the customer

False

Request-Id

string

(Request Id)

Format - uuid.

True

Name

Type

Summary

Required

Related Action

client_id

string

(Client Id)

A client ID that should be unique to developer/solution provider building the solution.

True

client_secret

string

(Client Secret)

A client secret that should be unique to developer/solution provider building the solution.

True

subscription_id

string

(Subscription Id)

A correlation ID that should be returned back to the caller to indicate the return of the given request.

True

Accept

string

(Accept)

Accept Header

False

Accept-Charset

string

(Accept-Charset)

Accept-Charset Header

False

Accept-Encoding

string

(Accept-Encoding)

Accept-Encoding Header

False

Accept-Language

string

(Accept-Language)

Accept-Language Header

False

If-Match

string

(If-Match)

If-Match Header

False

If-None-Match

string

(If-None-Match)

If-None-Match Header

False

Prefer

string

(Prefer)Values: [return=representation, return=minimal]

Preference of the customer

False

Request-Id

string

(Request Id)

Format - uuid.

True

Name

Type

Summary

Required

Related Action

positionName

string

(Position Name)

The position name

True

client_id

string

(Client Id)

A client ID that should be unique to developer/solution provider building the solution.

True

client_secret

string

(Client Secret)

A client secret that should be unique to developer/solution provider building the solution.

True

subscription_id

string

(Subscription Id)

A correlation ID that should be returned back to the caller to indicate the return of the given request.

True

Accept

string

(Accept)

Accept Header

False

Accept-Charset

string

(Accept-Charset)

Accept-Charset Header

False

Accept-Encoding

string

(Accept-Encoding)

Accept-Encoding Header

False

Accept-Language

string

(Accept-Language)

Accept-Language Header

False

If-Match

string

(If-Match)

If-Match Header

False

If-None-Match

string

(If-None-Match)

If-None-Match Header

False

Prefer

string

(Prefer)Values: [return=representation, return=minimal]

Preference of the customer

False

Request-Id

string

(Request Id)

Format - uuid.

True

Name

Type

Summary

Required

Related Action

client_id

string

(Client Id)

A client ID that should be unique to developer/solution provider building the solution.

True

client_secret

string

(Client Secret)

A client secret that should be unique to developer/solution provider building the solution.

True

subscription_id

string

(Subscription Id)

A correlation ID that should be returned back to the caller to indicate the return of the given request.

True

Accept

string

(Accept)

Accept Header

False

Accept-Charset

string

(Accept-Charset)

Accept-Charset Header

False

Accept-Encoding

string

(Accept-Encoding)

Accept-Encoding Header

False

Accept-Language

string

(Accept-Language)

Accept-Language Header

False

If-Match

string

(If-Match)

If-Match Header

False

If-None-Match

string

(If-None-Match)

If-None-Match Header

False

Prefer

string

(Prefer)Values: [return=representation, return=minimal]

Preference of the customer

False

Request-Id

string

(Request Id)

Format - uuid.

True

Name

Type

Summary

Required

Related Action

client_id

string

(Client Id)

A client ID that should be unique to developer/solution provider building the solution.

True

client_secret

string

(Client Secret)

A client secret that should be unique to developer/solution provider building the solution.

True

subscription_id

string

(Subscription Id)

A correlation ID that should be returned back to the caller to indicate the return of the given request.

True

Accept

string

(Accept)

Accept Header

False

Accept-Charset

string

(Accept-Charset)

Accept-Charset Header

False

Accept-Encoding

string

(Accept-Encoding)

Accept-Encoding Header

False

Accept-Language

string

(Accept-Language)

Accept-Language Header

False

If-Match

string

(If-Match)

If-Match Header

False

If-None-Match

string

(If-None-Match)

If-None-Match Header

False

Prefer

string

(Prefer)Values: [return=representation, return=minimal]

Preference of the customer

False

Request-Id

string

(Request Id)

Format - uuid.

True

Name

Type

Summary

Required

Related Action

client_id

string

(Client Id)

A client ID that should be unique to developer/solution provider building the solution.

True

client_secret

string

(Client Secret)

A client secret that should be unique to developer/solution provider building the solution.

True

subscription_id

string

(Subscription Id)

A correlation ID that should be returned back to the caller to indicate the return of the given request.

True

Accept

string

(Accept)

Accept Header

False

Accept-Charset

string

(Accept-Charset)

Accept-Charset Header

False

Accept-Encoding

string

(Accept-Encoding)

Accept-Encoding Header

False

Accept-Language

string

(Accept-Language)

Accept-Language Header

False

If-Match

string

(If-Match)

If-Match Header

False

If-None-Match

string

(If-None-Match)

If-None-Match Header

False

Prefer

string

(Prefer)Values: [return=representation, return=minimal]

Preference of the customer

False

Request-Id

string

(Request Id)

Format - uuid.

True

Name

Type

Summary

Required

Related Action

year

integer

(Year)

Year of Manufacturing

True

class

string

(Class)

Class of the vehicle

False

client_id

string

(Client Id)

A client ID that should be unique to developer/solution provider building the solution.

True

client_secret

string

(Client Secret)

A client secret that should be unique to developer/solution provider building the solution.

True

subscription_id

string

(Subscription Id)

A correlation ID that should be returned back to the caller to indicate the return of the given request.

True

Accept

string

(Accept)

Accept Header

False

Accept-Charset

string

(Accept-Charset)

Accept-Charset Header

False

Accept-Encoding

string

(Accept-Encoding)

Accept-Encoding Header

False

Accept-Language

string

(Accept-Language)

Accept-Language Header

False

If-Match

string

(If-Match)

If-Match Header

False

If-None-Match

string

(If-None-Match)

If-None-Match Header

False

Prefer

string

(Prefer)Values: [return=representation, return=minimal]

Preference of the customer

False

Request-Id

string

(Request Id)

Format - uuid.

True

Name

Type

Summary

Required

Related Action

year

integer

(Year)

Year of Manufacturing

True

make

string

(Make)

Make of the Car

True

client_id

string

(Client Id)

A client ID that should be unique to developer/solution provider building the solution.

True

client_secret

string

(Client Secret)

A client secret that should be unique to developer/solution provider building the solution.

True

subscription_id

string

(Subscription Id)

A correlation ID that should be returned back to the caller to indicate the return of the given request.

True

Accept

string

(Accept)

Accept Header

False

Accept-Charset

string

(Accept-Charset)

Accept-Charset Header

False

Accept-Encoding

string

(Accept-Encoding)

Accept-Encoding Header

False

Accept-Language

string

(Accept-Language)

Accept-Language Header

False

If-Match

string

(If-Match)

If-Match Header

False

If-None-Match

string

(If-None-Match)

If-None-Match Header

False

Prefer

string

(Prefer)Values: [return=representation, return=minimal]

Preference of the customer

False

Request-Id

string

(Request Id)

Format - uuid.

True

Name

Type

Summary

Required

Related Action

year

integer

(Year)

Year of Manufacturing

True

make

string

(Make)

Make of the Car

True

model

string

(Model)

Model of the Car

True

client_id

string

(Client Id)

A client ID that should be unique to developer/solution provider building the solution.

True

client_secret

string

(Client Secret)

A client secret that should be unique to developer/solution provider building the solution.

True

subscription_id

string

(Subscription Id)

A correlation ID that should be returned back to the caller to indicate the return of the given request.

True

Accept

string

(Accept)

Accept Header

False

Accept-Charset

string

(Accept-Charset)

Accept-Charset Header

False

Accept-Encoding

string

(Accept-Encoding)

Accept-Encoding Header

False

Accept-Language

string

(Accept-Language)

Accept-Language Header

False

If-Match

string

(If-Match)

If-Match Header

False

If-None-Match

string

(If-None-Match)

If-None-Match Header

False

Prefer

string

(Prefer)Values: [return=representation, return=minimal]

Preference of the customer

False

Request-Id

string

(Request Id)

Format - uuid.

True

Name

Type

Summary

address

string

Email address

Name

Type

Summary

items

array of (CompanyEmail)

A collection of company "from" email addresses

links

array of (LinkDescriptionObject)

A collection of HATEOAS links

Name

Type

Summary

items

array of (Employee)

A collection of company employees

links

array of (LinkDescriptionObject)

A collection of HATEOAS links

Name

Type

Summary

name

string

Company Opportunity Source Name

upType

string

Opportunity Source UpType  Values: [Campaign, Internet, Phone, Showroom]

isActive

boolean

true/false whether this company opportunity source is active

requestPhrase

string

(Future Use) Request phrase for the specified company opportunity source

requiresSubSource

boolean

true/false whether this company opportunity source requires a Subsource

hasSubSources

boolean

true/false whether this company opportunity source has subsources (path to retrieve these subsources is in the HATEOAS links collection)

links

array of (LinkDescriptionObject)

A collection of HATEOAS links

Name

Type

Summary

items

array of (CompanyOpportunitySource)

A collection of company opportunity sources

links

array of (LinkDescriptionObject)

A collection of HATEOAS links

Name

Type

Summary

status

string

Company Opportunity Status Name

subStatuses

array of (CompanyOpportunitySubStatus)

Name

Type

Summary

items

array of (CompanyOpportunityStatus)

A collection of company opportunity statuses

Name

Type

Summary

subStatus

string

Description of the sub status

Name

Type

Summary

name

string

Position name

code

string

Position code

hasEmployees

boolean

true/false whether this company position has employees (path to retrieve these employees is in the HATEOAS links collection)

links

array of (LinkDescriptionObject)

A collection of HATEOAS links

Name

Type

Summary

items

array of (CompanyPosition)

A collection of company positions

links

array of (LinkDescriptionObject)

A collection of HATEOAS links

Name

Type

Summary

name

string

Sales step name

abbreviation

string

Abbreviation for the sales step name

isActive

boolean

true/false whether this sales step is active

sortOrder

integer

Intended order of the sales step if building a drop down in UI

Name

Type

Summary

items

array of (CompanySalesStep)

A collection of company sales steps

links

array of (LinkDescriptionObject)

A collection of HATEOAS links

Name

Type

Summary

id

string(uuid)

Employee identifier

firstName

string

Employee first name

lastName

string

Employee last name

isActive

boolean

true/false whether this employee is active within the company

isOff

boolean

true/false whether this employee is currently working and can accept new internet opportunities being processed into the system

links

array of (LinkDescriptionObject)

A collection of HATEOAS links

Name

Type

Summary

href

string

The target URI

rel

string

The link relation type

method

string

The HTTP verb that MUST be used to make a request to the target of the link

title

string

The title that describes the object

Name

Type

Summary

name

string

Opportunity subsource name

isActive

boolean

true/false whether this opportunity subsource is active

Name

Type

Summary

items

array of (OpportunitySubSource)

A collection of opportunity subsources

links

array of (LinkDescriptionObject)

A collection of HATEOAS links

Name

Type

Summary

name

string

Vehicle class name

links

array of (LinkDescriptionObject)

A collection of HATEOAS links

Name

Type

Summary

items

array of (VehicleClass)

A collection of vehicle classes

links

array of (LinkDescriptionObject)

A collection of HATEOAS links

Name

Type

Summary

name

string

Vehicle make name

links

array of (LinkDescriptionObject)

A collection of HATEOAS links

Name

Type

Summary

year

integer

Vehicle year for this collection of vehicle makes

items

array of (VehicleMake)

A collection of vehicle makes

links

array of (LinkDescriptionObject)

A collection of HATEOAS links

Name

Type

Summary

name

string

Vehicle Model Name

links

array of (LinkDescriptionObject)

A collection of HATEOAS links

Name

Type

Summary

year

integer

Vehicle year for this collection of vehicle models

make

string

Vehicle make for this collection of vehicle models

items

array of (VehicleModel)

A collection of vehicle models

links

array of (LinkDescriptionObject)

A collection of HATEOAS links

Name

Type

Summary

name

string

Vehicle trim name

links

array of (LinkDescriptionObject)

A collection of HATEOAS links

Name

Type

Summary

year

integer

Vehicle year for this collection of vehicle trims

make

string

Vehicle make for this collection of vehicle trims

model

string

Vehicle model for this collection of vehicle trims

items

array of (VehicleTrim)

A collection of vehicle trims

links

array of (LinkDescriptionObject)

A collection of HATEOAS links

Name

Type

Summary

year

integer(int32)

Vehicle year

links

array of (LinkDescriptionObject)

A collection of HATEOAS links

Name

Type

Summary

items

array of (VehicleYear)

A collection of vehicle years

links

array of (LinkDescriptionObject)

A collection of HATEOAS links