Business Coder:Response: Difference between revisions

From Melissa Data Wiki
Jump to navigation Jump to search
Created page with "{{ BusinessCoderNav |ResponseCollapse= }} {{CustomTOC}} A response is the result of a request. This consists of returned results codes and Bussiness details. IP Locator su..."
 
No edit summary
 
(30 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{ BusinessCoderNav
{{ BusinessCoderNav
|ResponseCollapse=
|InputOutputCollapse=
}}
}}


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


A response is the result of a request. This consists of returned results codes and Bussiness details.
A response is the result of a request. This consists of returned results codes and Business details.
 
Business Coder supports the JSON response protocol.


IP Locator supports the JSON response protocol.


<!--  style="vertical-align:top;" -->
==Field Names==
==Field Names==
This is a list of the response field names and their grouping.
This is a list of the response field names and their grouping.


You can choose what output columns to return by entering the column name in the [Business Coder:Request#Column|Column] input. Specifying a gropu name will return all columns in the group.
You can choose what output columns to return by entering the column name in the [[Business Coder:Request#Column|Column]] input. Specifying a group name will return all columns in the group.


{| class="alternate01 sortable"
{| class="alternate01 sortable"
!Field Name !! Group
!Field Name !! Group
|-
|-
|LocationType||rowspan="6"|'''[NO GROUP]'''
|TransmissionResults||rowspan="16"|'''[DEFAULT]'''
These columns must be requested individually.
Always return in the output structure.
|-
|TransmissionReference
|-
|Version
|-
|-
|Phone
|TotalRecords
|-
|-
|StockTicker
|Records
|-
|-
|WebAddress
|Results
|-
|-
|EmployeesEstimate
|RecordID
|-
|-
|SalesEstimate
|CompanyName
|-
|-
|CompanyName||rowspan="6"|'''[DEFAULT]'''
|CurrentCompanyName
Always return in the output structure.
|-
|-
|AddressLine1
|AddressLine1
Line 45: Line 48:
|PostalCode
|PostalCode
|-
|-
|FemaleOwned||rowspan="3"|'''GrpBusinessInfo'''
|TotalContacts
|-
|MelissaEnterpriseKey
|-
|LocationType||rowspan="7"|'''[NO GROUP]'''
These columns must be requested individually.
|-
|Phone
|-
|EmployeesEstimate
|-
|SalesEstimate
|-
|StockTicker
|-
|WebAddress
|-
|Contacts
|-
|-
|SmallBusiness
|CountryCode||rowspan="6"|'''GrpAddressDetails'''
|-
|-
|HomeBasedBusiness
|CountryName
|-
|-
|SICCode||rowspan="6"|'''GrpBusinessCodes'''
|DeliveryIndicator
|-
|MelissaAddressKey
|-
|MelissaAddressKeyBase
|-
|Plus4
|-
|EIN||rowspan="7"|'''GrpBusinessCodes'''
|-
|SICCode1
|-
|-
|SICCode2
|SICCode2
Line 57: Line 87:
|SICCode3
|SICCode3
|-
|-
|NAICSCode
|NAICSCode1
|-
|-
|NAICSCode2
|NAICSCode2
Line 63: Line 93:
|NAICSCode3
|NAICSCode3
|-
|-
|SICDescription||rowspan="6"|'''GrpBusinessDescription'''
|SICDescription1||rowspan="6"|'''GrpBusinessDescription'''
|-
|-
|SICDescription2
|SICDescription2
Line 69: Line 99:
|SICDescription3
|SICDescription3
|-
|-
|NAICSDescription
|NAICSDescription1
|-
|-
|NAICSDescription2
|NAICSDescription2
|-
|-
|NAICSDescription3
|NAICSDescription3
|-
|Latitude||rowspan="2"|'''GrpGeoCode'''
|-
|Longitude
|-
|CountyName||rowspan="6"|'''GrpCensus'''
|-
|CountyFIPS
|-
|CensusTract
|-
|CensusBlock
|-
|PlaceCode
|-
|PlaceName
|}
|}




==[NO GROUP]==
==[DEFAULT]==
The following elements set the basic options for each request. These apply to the entire request, not the individual records.
<h3 style="background-color:rgb(240,240,240);">TransmissionResults</h3>
 
:Returns the generic web service level result/error codes. For more information, see [[Business Coder:Result Codes|Business Coder Result Codes]].
<h3 style="background-color:rgb(240,240,240);">LocationType</h3>
:Code denoting the business location type.


:{| class="alternate01"
:{| class="alternate01"
!Code !! Definition
!Protocol !! Syntax
|-
|-
|{blank}||Single Location
|JSON||<code>"TransmissionResults":"'''''string'''''"</code>
|-
|1||Headquarters
|-
|2||Branches
|-
|3||Subsidiary Headquarters
|}
|}


<h3 style="background-color:rgb(240,240,240);">TransmissionReference</h3>
:A pass-through of the input Transmission Reference.


:{| class="alternate01"
:{| class="alternate01"
!Protocol !! Syntax
!Protocol !! Syntax
|-
|-
|JSON||"LocationType":"string"
|JSON||<code>"TransmissionReference":"'''''string'''''"</code>
|}
|}




<h3 style="background-color:rgb(240,240,240);">Phone</h3>
<h3 style="background-color:rgb(240,240,240);">Version</h3>
:10-digit phone number.
:The current web service version.


:{| class="alternate01"
:{| class="alternate01"
!Protocol !! Syntax
!Protocol !! Syntax
|-
|-
|JSON||"Phone":"string"
|JSON||<code>"Version":"'''''string'''''"</code>
|}
|}




<h3 style="background-color:rgb(240,240,240);">StockTicker</h3>
<h3 style="background-color:rgb(240,240,240);">TotalRecords</h3>
:
:The total number of records returned in the records array.


:{| class="alternate01"
:{| class="alternate01"
!Protocol !! Syntax
!Protocol !! Syntax
|-
|-
|JSON||"StockTicker":"string"
|JSON||<code>"TotalRecords":"'''''string'''''"</code>
|}
|}




<h3 style="background-color:rgb(240,240,240);">WebAddress</h3>
<h3 style="background-color:rgb(240,240,240);">Records</h3>
:
:This is the returned array of records.


:{| class="alternate01"
:{| class="alternate01"
!Protocol !! Syntax
!Protocol !! Syntax
|-
|-
|JSON||"WebAddress":"string"
|JSON||<code>"Records":"'''''string'''''"</code>
|}
|}




<h3 style="background-color:rgb(240,240,240);">EmployeesEstimate</h3>
<h3 style="background-color:rgb(240,240,240);">Results</h3>
:
:Returns record specific result codes. For more information, see [[Business Coder:Result Codes|Business Coder Result Codes]].


:{| class="alternate01"
:{| class="alternate01"
!Protocol !! Syntax
!Protocol !! Syntax
|-
|-
|JSON||"EmployeesEstimate":"string"
|JSON||<code>"Results":"'''''string'''''"</code>
|}
|}




<h3 style="background-color:rgb(240,240,240);">SalesEstimate</h3>
<h3 style="background-color:rgb(240,240,240);">RecordID</h3>
:
:Position of the record in the response array.


:{| class="alternate01"
:{| class="alternate01"
!Protocol !! Syntax
!Protocol !! Syntax
|-
|-
|JSON||"SalesEstimate":"string"
|JSON||<code>"RecordID":"'''''string'''''"</code>
|}
|}




==[DEFAULT]==
<h3 style="background-color:rgb(240,240,240);">CompanyName</h3>
<h3 style="background-color:rgb(240,240,240);">CompanyName</h3>
:Name of the business.
:Name of the business.
Line 160: Line 200:
!Protocol !! Syntax
!Protocol !! Syntax
|-
|-
|JSON||"CompanyName":"string"
|JSON||<code>"CompanyName":"'''''string'''''"</code>
|}
 
 
<h3 style="background-color:rgb(240,240,240);">CurrentCompanyName</h3>
:The company name in our reference data. You can use this to easily compare your input company name against Melissa records for that address.
:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"CurrentCompanyName":"'''''string'''''"</code>
|}
|}


Line 170: Line 219:
!Protocol !! Syntax
!Protocol !! Syntax
|-
|-
|JSON||"AddressLine1":"string"
|JSON||<code>"AddressLine1":"'''''string'''''"</code>
|}
|}




<h3 style="background-color:rgb(240,240,240);">Suite</h3>
<h3 style="background-color:rgb(240,240,240);">Suite</h3>
:
:Returns the apartment number.


:{| class="alternate01"
:{| class="alternate01"
!Protocol !! Syntax
!Protocol !! Syntax
|-
|-
|JSON||"Suite":"string"
|JSON||<code>"Suite":"'''''string'''''"</code>
|}
|}


Line 190: Line 239:
!Protocol !! Syntax
!Protocol !! Syntax
|-
|-
|JSON||"City":"string"
|JSON||<code>"City":"'''''string'''''"</code>
|}
|}


Line 200: Line 249:
!Protocol !! Syntax
!Protocol !! Syntax
|-
|-
|JSON||"State":"string"
|JSON||<code>"State":"'''''string'''''"</code>
|}
|}


Line 210: Line 259:
!Protocol !! Syntax
!Protocol !! Syntax
|-
|-
|JSON||"PostalCode":"string"
|JSON||<code>"PostalCode":"'''''string'''''"</code>
|}
 
 
<h3 style="background-color:rgb(240,240,240);">TotalContacts</h3>
:Returns the number of employee contacts we have in our databases
 
:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"TotalContacts":"'''''string'''''"</code>
|}
|}




==GrpBusinessInfo==
<h3 style="background-color:rgb(240,240,240);">MelissaEnterpriseKey</h3>
<h3 style="background-color:rgb(240,240,240);">FemaleOwned</h3>
:The Unique Key assigned to a business for that location.
:Indicates if the business is owned by a female.
 
:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"MelissaEnterpriseKey":"'''''string'''''"</code>
|}
 
 
==[NO GROUP]==
The following elements set the basic options for each request. These apply to the entire request, not the individual records.
 
<h3 style="background-color:rgb(240,240,240);">LocationType</h3>
:Code denoting the business location type.


:{| class="alternate01"
:{| class="alternate01"
!Code !! Definition
!Code !! Definition
|-
|-
|{blank}||No
|1||Headquarters
|-
|2||Branches
|-
|3||Subsidiary Headquarters
|-
|-
|1||Yes
|4||Single Location
|}
|}


Line 230: Line 305:
!Protocol !! Syntax
!Protocol !! Syntax
|-
|-
|JSON||"FemaleOwned":"string"
|JSON||<code>"LocationType":"'''''string'''''"</code>
|}
|}




<h3 style="background-color:rgb(240,240,240);">SmallBusiness</h3>
<h3 style="background-color:rgb(240,240,240);">Phone</h3>
:Indicates if the business is a small business.
:10-digit phone number.


:{| class="alternate01"
:{| class="alternate01"
!Code !! Definition
!Protocol !! Syntax
|-
|JSON||<code>"Phone":"'''''string'''''"</code>
|}
 
 
<h3 style="background-color:rgb(240,240,240);">EmployeesEstimate</h3>
:The number of employees who work at this business location.
 
:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"EmployeesEstimate":"'''''string'''''"</code>
|}
 
 
<h3 style="background-color:rgb(240,240,240);">SalesEstimate</h3>
:The sales volume and/or assets of the business.
 
:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"SalesEstimate":"'''''string'''''"</code>
|}
 
 
<h3 style="background-color:rgb(240,240,240);">StockTicker</h3>
:The assigned stock exchange abbreviation/symbol for the business.
 
:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"StockTicker":"'''''string'''''"</code>
|}
 
 
<h3 style="background-color:rgb(240,240,240);">WebAddress</h3>
:The web address/domain for the business.
 
:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"WebAddress":"'''''string'''''"</code>
|}
 
 
<h3 style="background-color:rgb(240,240,240);">Contacts</h3>
:Returns JSON Array: NameFirst, NameLast, Gender, Title, and Email of one or more contacts.
 
:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON Array
|<code>
"Contacts":[{<br>
"NameFirst": "'''''string'''''",<br>
"NameLast": "'''''string'''''",<br>
"Gender": "'''''string'''''",<br>
"Title": "'''''string'''''",<br>
"ContactPhone": "'''''string'''''",<br>
"Email": "'''''string'''''"<br>
}]
</code>
|}
 
 
==GrpAddressDetails==
<h3 style="background-color:rgb(240,240,240);">CountryCode</h3>
:The 2-Character Country Code.
 
:{| class="alternate01"
!Protocol !! Syntax
|-
|-
|0||No
|JSON||<code>"CountryCode":"'''''string'''''"</code>
|}
 
 
<h3 style="background-color:rgb(240,240,240);">CountryName</h3>
:The name of the Country based on address.
 
:{| class="alternate01"
!Protocol !! Syntax
|-
|-
|1||Yes
|JSON||<code>"CountryName":"'''''string'''''"</code>
|}
|}


<h3 style="background-color:rgb(240,240,240);">DeliveryIndicator</h3>
:The RBDI Indicator based on the address.


:{| class="alternate01"
:{| class="alternate01"
!Protocol !! Syntax
!Protocol !! Syntax
|-
|-
|JSON||"SmallBusiness":"string"
|JSON||<code>"DeliveryIndicator":"'''''string'''''"</code>
|}
|}




<h3 style="background-color:rgb(240,240,240);">HomeBasedBusiness</h3>
<h3 style="background-color:rgb(240,240,240);">MelissaAddressKey</h3>
:Indicates if the business is a home business.
:(MAK) A unique key assigned to an address record.


:{| class="alternate01"
:{| class="alternate01"
!Code !! Definition
!Protocol !! Syntax
|-
|-
|{blank}||No
|JSON||<code>"MelissaAddressKey":"'''''string'''''"</code>
|}
 
 
<h3 style="background-color:rgb(240,240,240);">MelissaAddressKeyBase</h3>
:A unique key assigned to the base address of a complex with apartments or suites.
 
:{| class="alternate01"
!Protocol !! Syntax
|-
|-
|1||Yes
|JSON||<code>"MelissaAddressKeyBase":"'''''string'''''"</code>
|}
|}


<h3 style="background-color:rgb(240,240,240);">Plus4</h3>
:The Plus4 of the address.


:{| class="alternate01"
:{| class="alternate01"
!Protocol !! Syntax
!Protocol !! Syntax
|-
|-
|JSON||"HomeBasedBusiness":"string"
|JSON||<code>"Plus4":"'''''string'''''"</code>
|}
|}




==GrpBusinessCodes==
==GrpBusinessCodes==
<h3 style="background-color:rgb(240,240,240);">SICCode</h3>
<h3 style="background-color:rgb(240,240,240);">EIN</h3>
:
:The Employer Identification Number for the business.


:{| class="alternate01"
:{| class="alternate01"
!Protocol !! Syntax
!Protocol !! Syntax
|-
|-
|JSON||"SICCode":"string"
|JSON||<code>"EIN":"'''''string'''''"</code>
|}
 
 
<h3 style="background-color:rgb(240,240,240);">SICCode1</h3>
:A 6-digit SIC code for the business's primary line of business.
 
:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"SICCode1":"'''''string'''''"</code>
|}
|}




<h3 style="background-color:rgb(240,240,240);">SICCode2</h3>
<h3 style="background-color:rgb(240,240,240);">SICCode2</h3>
:
:The second SIC code.


:{| class="alternate01"
:{| class="alternate01"
!Protocol !! Syntax
!Protocol !! Syntax
|-
|-
|JSON||"SICCode2":"string"
|JSON||<code>"SICCode2":"'''''string'''''"</code>
|}
|}




<h3 style="background-color:rgb(240,240,240);">SICCode3</h3>
<h3 style="background-color:rgb(240,240,240);">SICCode3</h3>
:
:The third SIC code.


:{| class="alternate01"
:{| class="alternate01"
!Protocol !! Syntax
!Protocol !! Syntax
|-
|-
|JSON||"SICCode3":"string"
|JSON||<code>"SICCode3":"'''''string'''''"</code>
|}
|}




<h3 style="background-color:rgb(240,240,240);">NAICSCode</h3>
<h3 style="background-color:rgb(240,240,240);">NAICSCode1</h3>
:
:North American Industry Classification System code. This is related to [[#SICCode1|SICCode1]].


:{| class="alternate01"
:{| class="alternate01"
!Protocol !! Syntax
!Protocol !! Syntax
|-
|-
|JSON||"NAICSCode":"string"
|JSON||<code>"NAICSCode1":"'''''string'''''"</code>
|}
|}




<h3 style="background-color:rgb(240,240,240);">NAICSCode2</h3>
<h3 style="background-color:rgb(240,240,240);">NAICSCode2</h3>
:
:Second NAICS code. This is related to [[#SICCode2|SICCode2]].


:{| class="alternate01"
:{| class="alternate01"
!Protocol !! Syntax
!Protocol !! Syntax
|-
|-
|JSON||"NAICSCode":"string"
|JSON||<code>"NAICSCode2":"'''''string'''''"</code>
|}
|}




<h3 style="background-color:rgb(240,240,240);">NAICSCode3</h3>
<h3 style="background-color:rgb(240,240,240);">NAICSCode3</h3>
:
:Third NAICS code. This is related to [[#SICCode3|SICCode3]].


:{| class="alternate01"
:{| class="alternate01"
!Protocol !! Syntax
!Protocol !! Syntax
|-
|-
|JSON||"NAICSCode3":"string"
|JSON||<code>"NAICSCode3":"'''''string'''''"</code>
|}
|}




==GrpBusinessDescription==
==GrpBusinessDescription==
<h3 style="background-color:rgb(240,240,240);">SICDescription</h3>
<h3 style="background-color:rgb(240,240,240);">SICDescription1</h3>
:
:First SIC code description. Related to [[#SICCode1|SICCode1]].


:{| class="alternate01"
:{| class="alternate01"
!Protocol !! Syntax
!Protocol !! Syntax
|-
|-
|JSON||"SICDescription":"string"
|JSON||<code>"SICDescription1":"'''''string'''''"</code>
|}
|}




<h3 style="background-color:rgb(240,240,240);">SICDescription2</h3>
<h3 style="background-color:rgb(240,240,240);">SICDescription2</h3>
:
:Second SIC code description. Related to [[#SICCode2|SICCode2]].


:{| class="alternate01"
:{| class="alternate01"
!Protocol !! Syntax
!Protocol !! Syntax
|-
|-
|JSON||"SICDescription2":"string"
|JSON||<code>"SICDescription2":"'''''string'''''"</code>
|}
|}




<h3 style="background-color:rgb(240,240,240);">SICDescription3</h3>
<h3 style="background-color:rgb(240,240,240);">SICDescription3</h3>
:
:Third SIC code description. Related to [[#SICCode3|SICCode3]].


:{| class="alternate01"
:{| class="alternate01"
!Protocol !! Syntax
!Protocol !! Syntax
|-
|-
|JSON||"SICDescription3":"string"
|JSON||<code>"SICDescription3":"'''''string'''''"</code>
|}
|}




<h3 style="background-color:rgb(240,240,240);">NAICSDescription</h3>
<h3 style="background-color:rgb(240,240,240);">NAICSDescription1</h3>
:
:First NAICS code description. Related to [[#NAICSCode1|NAICSCode1]].


:{| class="alternate01"
:{| class="alternate01"
!Protocol !! Syntax
!Protocol !! Syntax
|-
|-
|JSON||"NAICSDescription":"string"
|JSON||<code>"NAICSDescription1":"'''''string'''''"</code>
|}
|}




<h3 style="background-color:rgb(240,240,240);">NAICSDescription2</h3>
<h3 style="background-color:rgb(240,240,240);">NAICSDescription2</h3>
:
:Second NAICS code description. Related to [[#NAICSCode2|NAICSCode2]].


:{| class="alternate01"
:{| class="alternate01"
!Protocol !! Syntax
!Protocol !! Syntax
|-
|-
|JSON||"NAICSDescription2":"string"
|JSON||<code>"NAICSDescription2":"'''''string'''''"</code>
|}
|}




<h3 style="background-color:rgb(240,240,240);">NAICSDescription3</h3>
<h3 style="background-color:rgb(240,240,240);">NAICSDescription3</h3>
:
:Third NAICS code description. Related to [[#NAICSCode3|NAICSCode3]].
 
:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"NAICSDescription3":"'''''string'''''"</code>
|}
 
 
==GrpGeoCode==
<h3 style="background-color:rgb(240,240,240);">Latitude</h3>
:The latitude geo coordinate.
 
:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"Latitude":"'''''string'''''"</code>
|}
 
 
<h3 style="background-color:rgb(240,240,240);">Longitude</h3>
:The longitude geo coordinate.
 
:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"Longitude":"'''''string'''''"</code>
|}
 
 
==GrpCensus==
<h3 style="background-color:rgb(240,240,240);">CountyName</h3>
:The name of the county.
 
:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"CountyName":"'''''string'''''"</code>
|}
 
 
<h3 style="background-color:rgb(240,240,240);">CountyFIPS</h3>
:The FIPS code of the county.
 
:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"CountyFIPS":"'''''string'''''"</code>
|}
 
 
<h3 style="background-color:rgb(240,240,240);">CensusTract</h3>
:The census tract number for the address.
 
:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"CensusTract":"'''''string'''''"</code>
|}
 
 
<h3 style="background-color:rgb(240,240,240);">CensusBlock</h3>
:The census block number for the address.
 
:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"CensusBlock":"'''''string'''''"</code>
|}
 
 
<h3 style="background-color:rgb(240,240,240);">PlaceCode</h3>
:The Census Bureau place code.
 
:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"PlaceCode":"'''''string'''''"</code>
|}
 
 
<h3 style="background-color:rgb(240,240,240);">PlaceName</h3>
:The Census Bureau place name.


:{| class="alternate01"
:{| class="alternate01"
!Protocol !! Syntax
!Protocol !! Syntax
|-
|-
|JSON||"NAICSDescription3":"string"
|JSON||<code>"PlaceName":"'''''string'''''"</code>
|}
|}


Latest revision as of 00:25, 9 December 2020

← 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 response is the result of a request. This consists of returned results codes and Business details.

Business Coder supports the JSON response protocol.


Field Names

This is a list of the response field names and their grouping.

You can choose what output columns to return by entering the column name in the Column input. Specifying a group name will return all columns in the group.

Field Name Group
TransmissionResults [DEFAULT]

Always return in the output structure.

TransmissionReference
Version
TotalRecords
Records
Results
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


[DEFAULT]

TransmissionResults

Returns the generic web service level result/error codes. For more information, see Business Coder Result Codes.
Protocol Syntax
JSON "TransmissionResults":"string"


TransmissionReference

A pass-through of the input Transmission Reference.
Protocol Syntax
JSON "TransmissionReference":"string"


Version

The current web service version.
Protocol Syntax
JSON "Version":"string"


TotalRecords

The total number of records returned in the records array.
Protocol Syntax
JSON "TotalRecords":"string"


Records

This is the returned array of records.
Protocol Syntax
JSON "Records":"string"


Results

Returns record specific result codes. For more information, see Business Coder Result Codes.
Protocol Syntax
JSON "Results":"string"


RecordID

Position of the record in the response array.
Protocol Syntax
JSON "RecordID":"string"


CompanyName

Name of the business.
Protocol Syntax
JSON "CompanyName":"string"


CurrentCompanyName

The company name in our reference data. You can use this to easily compare your input company name against Melissa records for that address.
Protocol Syntax
JSON "CurrentCompanyName":"string"


AddressLine1

Address Line 1 of the business.
Protocol Syntax
JSON "AddressLine1":"string"


Suite

Returns the apartment number.
Protocol Syntax
JSON "Suite":"string"


City

City of the business.
Protocol Syntax
JSON "City":"string"


State

State of the business.
Protocol Syntax
JSON "State":"string"


PostalCode

Zip/Postal Code of the business.
Protocol Syntax
JSON "PostalCode":"string"


TotalContacts

Returns the number of employee contacts we have in our databases
Protocol Syntax
JSON "TotalContacts":"string"


MelissaEnterpriseKey

The Unique Key assigned to a business for that location.
Protocol Syntax
JSON "MelissaEnterpriseKey":"string"


[NO GROUP]

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

LocationType

Code denoting the business location type.
Code Definition
1 Headquarters
2 Branches
3 Subsidiary Headquarters
4 Single Location


Protocol Syntax
JSON "LocationType":"string"


Phone

10-digit phone number.
Protocol Syntax
JSON "Phone":"string"


EmployeesEstimate

The number of employees who work at this business location.
Protocol Syntax
JSON "EmployeesEstimate":"string"


SalesEstimate

The sales volume and/or assets of the business.
Protocol Syntax
JSON "SalesEstimate":"string"


StockTicker

The assigned stock exchange abbreviation/symbol for the business.
Protocol Syntax
JSON "StockTicker":"string"


WebAddress

The web address/domain for the business.
Protocol Syntax
JSON "WebAddress":"string"


Contacts

Returns JSON Array: NameFirst, NameLast, Gender, Title, and Email of one or more contacts.
Protocol Syntax
JSON Array

"Contacts":[{
"NameFirst": "string",
"NameLast": "string",
"Gender": "string",
"Title": "string",
"ContactPhone": "string",
"Email": "string"
}]


GrpAddressDetails

CountryCode

The 2-Character Country Code.
Protocol Syntax
JSON "CountryCode":"string"


CountryName

The name of the Country based on address.
Protocol Syntax
JSON "CountryName":"string"


DeliveryIndicator

The RBDI Indicator based on the address.
Protocol Syntax
JSON "DeliveryIndicator":"string"


MelissaAddressKey

(MAK) A unique key assigned to an address record.
Protocol Syntax
JSON "MelissaAddressKey":"string"


MelissaAddressKeyBase

A unique key assigned to the base address of a complex with apartments or suites.
Protocol Syntax
JSON "MelissaAddressKeyBase":"string"


Plus4

The Plus4 of the address.
Protocol Syntax
JSON "Plus4":"string"


GrpBusinessCodes

EIN

The Employer Identification Number for the business.
Protocol Syntax
JSON "EIN":"string"


SICCode1

A 6-digit SIC code for the business's primary line of business.
Protocol Syntax
JSON "SICCode1":"string"


SICCode2

The second SIC code.
Protocol Syntax
JSON "SICCode2":"string"


SICCode3

The third SIC code.
Protocol Syntax
JSON "SICCode3":"string"


NAICSCode1

North American Industry Classification System code. This is related to SICCode1.
Protocol Syntax
JSON "NAICSCode1":"string"


NAICSCode2

Second NAICS code. This is related to SICCode2.
Protocol Syntax
JSON "NAICSCode2":"string"


NAICSCode3

Third NAICS code. This is related to SICCode3.
Protocol Syntax
JSON "NAICSCode3":"string"


GrpBusinessDescription

SICDescription1

First SIC code description. Related to SICCode1.
Protocol Syntax
JSON "SICDescription1":"string"


SICDescription2

Second SIC code description. Related to SICCode2.
Protocol Syntax
JSON "SICDescription2":"string"


SICDescription3

Third SIC code description. Related to SICCode3.
Protocol Syntax
JSON "SICDescription3":"string"


NAICSDescription1

First NAICS code description. Related to NAICSCode1.
Protocol Syntax
JSON "NAICSDescription1":"string"


NAICSDescription2

Second NAICS code description. Related to NAICSCode2.
Protocol Syntax
JSON "NAICSDescription2":"string"


NAICSDescription3

Third NAICS code description. Related to NAICSCode3.
Protocol Syntax
JSON "NAICSDescription3":"string"


GrpGeoCode

Latitude

The latitude geo coordinate.
Protocol Syntax
JSON "Latitude":"string"


Longitude

The longitude geo coordinate.
Protocol Syntax
JSON "Longitude":"string"


GrpCensus

CountyName

The name of the county.
Protocol Syntax
JSON "CountyName":"string"


CountyFIPS

The FIPS code of the county.
Protocol Syntax
JSON "CountyFIPS":"string"


CensusTract

The census tract number for the address.
Protocol Syntax
JSON "CensusTract":"string"


CensusBlock

The census block number for the address.
Protocol Syntax
JSON "CensusBlock":"string"


PlaceCode

The Census Bureau place code.
Protocol Syntax
JSON "PlaceCode":"string"


PlaceName

The Census Bureau place name.
Protocol Syntax
JSON "PlaceName":"string"
Retrieved from "http://wiki.melissadata.com/index.php?title=Business_Coder:Response&oldid=17426"