Business Coder:Request: Difference between revisions

From Melissa Data Wiki
Jump to navigation Jump to search
Created page with "{{ BusinessCoderNav |RequestCollapse= }} {{CustomTOC}} A request consists of a protocol to make a call to the service, detailing desired elements. Your Customer ID is requi..."
 
No edit summary
 
(28 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{ BusinessCoderNav
{{ BusinessCoderNav
|RequestCollapse=
|InputOutputCollapse=
}}
}}


Line 6: Line 6:
{{CustomTOC}}
{{CustomTOC}}


A request consists of a protocol to make a call to the service, detailing desired elements. Your Customer ID is required.
A request consists of a protocol to make a call to the service, detailing desired elements. Your License Key is required.


Business Coder supports the REST protocol to access the service.
Business Coder supports the JSON and REST protocols to access the service.
 
 
==URL==
{{URL-BusinessCoder}}




Line 15: Line 19:


{| class="alternate01 sortable"
{| class="alternate01 sortable"
!Field Name !! Level !! REST Abbreviation
!Field Name !! Level !! REST !! JSON
|- style="vertical-align:top;"
|Transmission Reference||Request||t
|-
|-
|License|| ||lic
|Transmission Reference||rowspan="4" valign="center"|Request||t||t
|-
|-
|Column|| ||cols
|License Key||id||id
|-
|-
|Options|| ||opt
|Column||cols||cols
|-
|-
|Company Name|| ||comp
|Options||opt||opt
|-
|-
|Phone Number|| ||phone
|Record ID||rowspan="15"|Record||rec||rec
|-
|-
|Address1|| ||a1
|Company Name||comp||comp
|-
|-
|Address2|| ||a2
|Phone Number||phone||phone
|-
|-
|City|| ||city
|Address1||a1||a1
|-
|-
|State|| ||state
|Address2||a2||a2
|-
|-
|Postal|| ||postal
|Suite||suite||suite
|-
|-
|Country|| ||ctry
|City||city||city
|-
|-
|Melissa Address Key (MAK)|| ||mkey
|State||state||state
|-
|-
|Stock Ticker|| ||stock
|Postal||postal||postal
|-
|-
|Web Address|| ||web
|Country||ctry||ctry
|-
|Melissa Address Key (MAK)||mak||mak
|-
|Stock Ticker||stock||stock
|-
|Web Address||web||web
|-
|Melissa Enterprise Key (MEK)||mek||mek
|-
|Free Form||ff||freeform
|}
|}
==Minimum Inputs==
The following are the possible minimum input requirements.
#Company Only
#MAK and Company
#Address Only
#MAK Only
#Phone Number
#Stock Ticker
#Web Address




Line 60: Line 84:
!Protocol !! Syntax
!Protocol !! Syntax
|-
|-
|REST||?t = {string}
|JSON||<code>"t":"'''''string'''''"</code>
|-
|REST||<code>?t = '''''string'''''</code>
|}
 
 
<h3 style="background-color:rgb(240,240,240);">License Key</h3>
:''Required.''
 
:This is a string value containing the License Key issued to the customer by Melissa Data for the Business Coder.
 
:If this element is absent, the Web Service will return an error. To receive a License Key, please contact your Melissa Data sales representative at 1-800-MELISSA.
 
:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"id":"'''''string'''''"</code>
|-
|REST||<code>&id = '''''string'''''</code>
|}
 
 
<h3 style="background-color:rgb(240,240,240);">Column</h3>
:''Optional.''
 
:This string value specifies which column(s) to be output as a comma delimited string.
 
:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"cols":"'''''string'''''"</code>
|-
|REST||<code>&cols = '''''string'''''</code>
|}
 
 
Entering the column name to return the column. Specifying a group name will return all columns in the group.
 
:{| class="alternate01 sortable"
!Field Name !! Group
|-
|TransmissionResults||rowspan="13"|'''[DEFAULT]'''
These columns are returned by default.
|-
|TransmissionReference
|-
|Records
|-
|RecordID
|-
|CompanyName
|-
|CurrentCompanyName
|-
|AddressLine1
|-
|Suite
|-
|City
|-
|State
|-
|PostalCode
|-
|TotalContacts
|-
|MelissaEnterpriseKey
|-
|LocationType||rowspan="7"|'''[NO GROUP]'''
These columns must be requested individually.
|-
|Phone
|-
|EmployeesEstimate
|-
|SalesEstimate
|-
|StockTicker
|-
|WebAddress
|-
|Contacts
|-
|CountryCode||rowspan="6"|'''GrpAddressDetails'''
|-
|CountryName
|-
|DeliveryIndicator
|-
|MelissaAddressKey
|-
|MelissaAddressKeyBase
|-
|Plus4
|-
|EIN||rowspan="7"|'''GrpBusinessCodes'''
|-
|SICCode1
|-
|SICCode2
|-
|SICCode3
|-
|NAICSCode1
|-
|NAICSCode2
|-
|NAICSCode3
|-
|SICDescription1||rowspan="6"|'''GrpBusinessDescription'''
|-
|SICDescription2
|-
|SICDescription3
|-
|NAICSDescription1
|-
|NAICSDescription2
|-
|NAICSDescription3
|-
|Latitude||rowspan="2"|'''GrpGeoCode'''
|-
|Longitude
|-
|CountyName||rowspan="6"|'''GrpCensus'''
|-
|CountyFIPS
|-
|CensusTract
|-
|CensusBlock
|-
|PlaceCode
|-
|PlaceName
|}
 
 
:{| class="alternate01"
!JSON Array returned by Contacts
|-
|Contacts:
|-
|style="padding-left:20px;"|NameFirst
|-
|style="padding-left:20px;"|NameLast
|-
|style="padding-left:20px;"|Gender
|-
|style="padding-left:20px;"|Title
|-
|style="padding-left:20px;"|Email
|}
 
 
<h3 style="background-color:rgb(240,240,240);">Options</h3>
:''Optional.''
 
:This is a string value containing the options set by the user.
 
:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"opt":"'''''string'''''"</code>
|-
|REST||<code>&opt = '''''string'''''</code>
|}
 
 
:List options in the following format.
 
:{| class="alternate01"
!Syntax
|-
|<code>''OptionName'':''Parameter''</code>
|}
 
 
:<h4 style="border-bottom:1px solid black;">CentricHint</h4>
::This option allows you to choose what the service will center the search around.
 
::{| class="alternate01 sortable"
!Option Name !! Parameter !! Description
|-
|rowspan="3"|'''CentricHint'''||<code>company</code>||Will use Company as the primary pivot.
|-
|<code>address</code>||Will us Address as a primary pivot.
|-
|<code>phone</code>||Will use Phone as a primary pivot.
|}
 
 
:<h4 style="border-bottom:1px solid black;">MaxContacts</h4>
::This option changes the upper limit on the number of contacts returned.
 
::{| class="alternate01 sortable"
!Option Name !! Parameter !! Description
|-
|rowspan="2"|'''MaxContacts'''||<code># [0 - #]</code>||'''''Default set to 5.''''' Sets the maximum number of contacts to be returned.
|}
 
 
:<h4 style="border-bottom:1px solid black;">ReturnDominantBusiness</h4>
::This option handles the returning of the dominant business name and demographics for a particular site when the company information is missing or does not match.
 
::{| class="alternate01 sortable"
!Option Name !! Parameter !! Description
|-
|rowspan="2"|'''ReturnDominantBusiness'''||<code>yes</code>||'''''Default.''''' Return the dominant business name when the company information is missing or does not match.
|-
|<code>no</code>||Do not return the dominant business name when the company information is missing or does not match.
|}
 
 
:<h4 style="border-bottom:1px solid black;">SICNAICSConfidence</h4>
::Will only return SIC Codes that we are very confident are correct. If they do not pass our requirements we will return null.
 
::{| class="alternate01 sortable"
!Option Name !! Parameter !! Description
|-
|rowspan="2"|'''SICNAICSConfidence'''||<code>strict</code>||Returns very confident or correct SIC Codes. Returns null if none pass the requirement.
|-
|<code>loose</code>||'''''Default.''''' Returns any associated SIC Codes.
|}
|}


Line 69: Line 316:
{| class="alternate01"
{| class="alternate01"
!Protocol !! Definition
!Protocol !! Definition
|-
|JSON||Each record will be contained within [{}] under the Records element.
|-
|-
|REST||The REST interface only allows a single record per request.
|REST||The REST interface only allows a single record per request.
Line 74: Line 323:




<h3 style="background-color:rgb(240,240,240);">PhoneNumber</h3>
<h3 style="background-color:rgb(240,240,240);">Record ID</h3>
:''Required.''
:''Optional.''
 
:This is a string value containing a unique identifier for the current record. Use this to match the record submitted with the record returned. It will return what is inputted.
 
:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"rec":"'''''string'''''"</code>
|-
|REST||<code>&rec = '''''string'''''</code>
|}
 
 
<h3 style="background-color:rgb(240,240,240);">Company Name</h3>
:''Optional.''
 
:The name of the business.
 
:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"comp":"'''''string'''''"</code>
|-
|REST||<code>&comp = '''''string'''''</code>
|}
 
 
<h3 style="background-color:rgb(240,240,240);">Phone Number</h3>
:''Optional.''
 
:The phone number of the business.
 
:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"phone":"'''''string'''''"</code>
|-
|REST||<code>&phone = '''''string'''''</code>
|}
 
 
<h3 style="background-color:rgb(240,240,240);">Address1</h3>
:''Optional.''
 
:The first address line of the business.
 
:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"a1":"'''''string'''''"</code>
|-
|REST||<code>&a1 = '''''string'''''</code>
|}
 
 
<h3 style="background-color:rgb(240,240,240);">Address2</h3>
:''Optional.''
 
:The second address line (suite) of the business.
 
:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"a2":"'''''string'''''"</code>
|-
|REST||<code>&a2 = '''''string'''''</code>
|}
 
 
<h3 style="background-color:rgb(240,240,240);">Suite</h3>
:''Optional.''
 
:The suite/apartment number for the business.
 
:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"suite":"'''''string'''''"</code>
|-
|REST||<code>&suite = '''''string'''''</code>
|}
 
 
<h3 style="background-color:rgb(240,240,240);">City</h3>
:''Optional.''
 
:The city (locality).
 
:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"city":"'''''string'''''"</code>
|-
|REST||<code>&city = '''''string'''''</code>
|}
 
 
<h3 style="background-color:rgb(240,240,240);">State</h3>
:''Optional.''
 
:The state (Administrative Area).
 
:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"state":"'''''string'''''"</code>
|-
|REST||<code>&state = '''''string'''''</code>
|}
 
 
<h3 style="background-color:rgb(240,240,240);">Postal</h3>
:''Optional.''
 
:The postal code.
 
:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"postal":"'''''string'''''"</code>
|-
|REST||<code>&postal = '''''string'''''</code>
|}
 
 
<h3 style="background-color:rgb(240,240,240);">Country</h3>
:''Optional.''
 
:The country.
 
:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"ctry":"'''''string'''''"</code>
|-
|REST||<code>&ctry = '''''string'''''</code>
|}
 
 
<h3 style="background-color:rgb(240,240,240);">Melissa Address Key (MAK)</h3>
:''Optional.''
 
:A propietary unique key identifier for an address. This is derived from Address Checking.
 
:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"mak":"'''''string'''''"</code>
|-
|REST||<code>&mak = '''''string'''''</code>
|}
 
 
<h3 style="background-color:rgb(240,240,240);">Stock Ticker</h3>
:''Optional.''
 
:A unique abbreviation/symbol assigned by the stock exchange for listed companies.
 
:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"stock":"'''''string'''''"</code>
|-
|REST||<code>&stock = '''''string'''''</code>
|}
 
 
<h3 style="background-color:rgb(240,240,240);">Web Address</h3>
:''Optional.''
 
:The web address/domain for a company.
 
:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"web":"'''''string'''''"</code>
|-
|REST||<code>&web = '''''string'''''</code>
|}
 
 
<h3 style="background-color:rgb(240,240,240);">Melissa Enterprise Key (MEK)</h3>
:''Optional.''
 
:The unique identifier given by Business Coder.
 
:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"mek":"'''''string'''''"</code>
|-
|REST||<code>&mek = '''''string'''''</code>
|}
 
 
<h3 style="background-color:rgb(240,240,240);">Free Form</h3>
:''Optional.''
 
:This is a string value which can contain one of the possible minimum input requirements.


:The phone number to be verified
:'''NOTE:''' If freeform is populated it will ignore all other input fields.


:{| class="alternate01"
:{| class="alternate01"
!Protocol !! Syntax
!Protocol !! Syntax
|-
|-
|REST||&phone = {string}
|JSON||<code>"ff":"'''''string'''''"</code>
|-
|REST||<code>&freeform = '''''string'''''</code>
|}
|}


Latest revision as of 00:04, 11 May 2022

← Business Coder

Business Coder Navigation
Introduction
Licensing
Input/Output
Request Fields
Response Fields
Examples
REST JSON
Result Codes
Result Code Use
Business Coder Result Codes
Sample Code



A request consists of a protocol to make a call to the service, detailing desired elements. Your License Key is required.

Business Coder supports the JSON and REST protocols to access the service.


URL

Use URL
Standard http://businesscoder.melissadata.net/WEB/BusinessCoder/doBusinessCoderUS
Secure https://businesscoder.melissadata.net/WEB/BusinessCoder/doBusinessCoderUS


Field Names

This is a list of the request field names and their protocol naming conventions.

Field Name Level REST JSON
Transmission Reference Request t t
License Key id id
Column cols cols
Options opt opt
Record ID Record rec rec
Company Name comp comp
Phone Number phone phone
Address1 a1 a1
Address2 a2 a2
Suite suite suite
City city city
State state state
Postal postal postal
Country ctry ctry
Melissa Address Key (MAK) mak mak
Stock Ticker stock stock
Web Address web web
Melissa Enterprise Key (MEK) mek mek
Free Form ff freeform


Minimum Inputs

The following are the possible minimum input requirements.

  1. Company Only
  2. MAK and Company
  3. Address Only
  4. MAK Only
  5. Phone Number
  6. Stock Ticker
  7. Web Address


Request Elements

The following elements set the basic options for each request. These apply to the entire request, not the individual records.

Transmission Reference

Optional.
This is a string value that serves as a unique identifier for this set of records. It is returned as sent.
Protocol Syntax
JSON "t":"string"
REST ?t = string


License Key

Required.
This is a string value containing the License Key issued to the customer by Melissa Data for the Business Coder.
If this element is absent, the Web Service will return an error. To receive a License Key, please contact your Melissa Data sales representative at 1-800-MELISSA.
Protocol Syntax
JSON "id":"string"
REST &id = string


Column

Optional.
This string value specifies which column(s) to be output as a comma delimited string.
Protocol Syntax
JSON "cols":"string"
REST &cols = string


Entering the column name to return the column. Specifying a group name will return all columns in the group.

Field Name Group
TransmissionResults [DEFAULT]

These columns are returned by default.

TransmissionReference
Records
RecordID
CompanyName
CurrentCompanyName
AddressLine1
Suite
City
State
PostalCode
TotalContacts
MelissaEnterpriseKey
LocationType [NO GROUP]

These columns must be requested individually.

Phone
EmployeesEstimate
SalesEstimate
StockTicker
WebAddress
Contacts
CountryCode GrpAddressDetails
CountryName
DeliveryIndicator
MelissaAddressKey
MelissaAddressKeyBase
Plus4
EIN GrpBusinessCodes
SICCode1
SICCode2
SICCode3
NAICSCode1
NAICSCode2
NAICSCode3
SICDescription1 GrpBusinessDescription
SICDescription2
SICDescription3
NAICSDescription1
NAICSDescription2
NAICSDescription3
Latitude GrpGeoCode
Longitude
CountyName GrpCensus
CountyFIPS
CensusTract
CensusBlock
PlaceCode
PlaceName


JSON Array returned by Contacts
Contacts:
NameFirst
NameLast
Gender
Title
Email


Options

Optional.
This is a string value containing the options set by the user.
Protocol Syntax
JSON "opt":"string"
REST &opt = string


List options in the following format.
Syntax
OptionName:Parameter


CentricHint

This option allows you to choose what the service will center the search around.
Option Name Parameter Description
CentricHint company Will use Company as the primary pivot.
address Will us Address as a primary pivot.
phone Will use Phone as a primary pivot.


MaxContacts

This option changes the upper limit on the number of contacts returned.
Option Name Parameter Description
MaxContacts # [0 - #] Default set to 5. Sets the maximum number of contacts to be returned.


ReturnDominantBusiness

This option handles the returning of the dominant business name and demographics for a particular site when the company information is missing or does not match.
Option Name Parameter Description
ReturnDominantBusiness yes Default. Return the dominant business name when the company information is missing or does not match.
no Do not return the dominant business name when the company information is missing or does not match.


SICNAICSConfidence

Will only return SIC Codes that we are very confident are correct. If they do not pass our requirements we will return null.
Option Name Parameter Description
SICNAICSConfidence strict Returns very confident or correct SIC Codes. Returns null if none pass the requirement.
loose Default. Returns any associated SIC Codes.


Request Record Elements

REST will only contain the Records element.

Protocol Definition
JSON Each record will be contained within [{}] under the Records element.
REST The REST interface only allows a single record per request.


Record ID

Optional.
This is a string value containing a unique identifier for the current record. Use this to match the record submitted with the record returned. It will return what is inputted.
Protocol Syntax
JSON "rec":"string"
REST &rec = string


Company Name

Optional.
The name of the business.
Protocol Syntax
JSON "comp":"string"
REST &comp = string


Phone Number

Optional.
The phone number of the business.
Protocol Syntax
JSON "phone":"string"
REST &phone = string


Address1

Optional.
The first address line of the business.
Protocol Syntax
JSON "a1":"string"
REST &a1 = string


Address2

Optional.
The second address line (suite) of the business.
Protocol Syntax
JSON "a2":"string"
REST &a2 = string


Suite

Optional.
The suite/apartment number for the business.
Protocol Syntax
JSON "suite":"string"
REST &suite = string


City

Optional.
The city (locality).
Protocol Syntax
JSON "city":"string"
REST &city = string


State

Optional.
The state (Administrative Area).
Protocol Syntax
JSON "state":"string"
REST &state = string


Postal

Optional.
The postal code.
Protocol Syntax
JSON "postal":"string"
REST &postal = string


Country

Optional.
The country.
Protocol Syntax
JSON "ctry":"string"
REST &ctry = string


Melissa Address Key (MAK)

Optional.
A propietary unique key identifier for an address. This is derived from Address Checking.
Protocol Syntax
JSON "mak":"string"
REST &mak = string


Stock Ticker

Optional.
A unique abbreviation/symbol assigned by the stock exchange for listed companies.
Protocol Syntax
JSON "stock":"string"
REST &stock = string


Web Address

Optional.
The web address/domain for a company.
Protocol Syntax
JSON "web":"string"
REST &web = string


Melissa Enterprise Key (MEK)

Optional.
The unique identifier given by Business Coder.
Protocol Syntax
JSON "mek":"string"
REST &mek = string


Free Form

Optional.
This is a string value which can contain one of the possible minimum input requirements.
NOTE: If freeform is populated it will ignore all other input fields.
Protocol Syntax
JSON "ff":"string"
REST &freeform = string
Retrieved from "http://wiki.melissadata.com/index.php?title=Business_Coder:Request&oldid=18785"