Business Coder:Response: Difference between revisions

From Melissa Data Wiki
Jump to navigation Jump to search
← Older edit
No edit summary
No edit summary
 
(22 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{ BusinessCoderNav
{{ BusinessCoderNav
|ResponseCollapse=
|InputOutputCollapse=
}}
}}


Line 19: Line 19:
!Field Name !! Group
!Field Name !! Group
|-
|-
|TransmissionResults||rowspan="12"|'''[DEFAULT]'''
|TransmissionResults||rowspan="16"|'''[DEFAULT]'''
Always return in the output structure.
Always return in the output structure.
|-
|-
Line 25: Line 25:
|-
|-
|Version
|Version
|-
|TotalRecords
|-
|-
|Records
|Records
Line 33: Line 35:
|-
|-
|CompanyName
|CompanyName
|-
|CurrentCompanyName
|-
|-
|AddressLine1
|AddressLine1
Line 44: Line 48:
|PostalCode
|PostalCode
|-
|-
|LocationType||rowspan="6"|'''[NO GROUP]'''
|TotalContacts
|-
|MelissaEnterpriseKey
|-
|LocationType||rowspan="7"|'''[NO GROUP]'''
These columns must be requested individually.
These columns must be requested individually.
|-
|-
Line 57: Line 65:
|WebAddress
|WebAddress
|-
|-
|Plus4||rowspan="4"|'''GrpAddressDetails'''
|Contacts
|-
|CountryCode||rowspan="6"|'''GrpAddressDetails'''
|-
|CountryName
|-
|-
|DeliveryIndicator
|DeliveryIndicator
Line 65: Line 77:
|MelissaAddressKeyBase
|MelissaAddressKeyBase
|-
|-
|SICCode||rowspan="6"|'''GrpBusinessCodes'''
|Plus4
|-
|EIN||rowspan="7"|'''GrpBusinessCodes'''
|-
|SICCode1
|-
|-
|SICCode2
|SICCode2
Line 71: Line 87:
|SICCode3
|SICCode3
|-
|-
|NAICSCode
|NAICSCode1
|-
|-
|NAICSCode2
|NAICSCode2
Line 77: Line 93:
|NAICSCode3
|NAICSCode3
|-
|-
|SICDescription||rowspan="6"|'''GrpBusinessDescription'''
|SICDescription1||rowspan="6"|'''GrpBusinessDescription'''
|-
|-
|SICDescription2
|SICDescription2
Line 83: Line 99:
|SICDescription3
|SICDescription3
|-
|-
|NAICSDescription
|NAICSDescription1
|-
|-
|NAICSDescription2
|NAICSDescription2
Line 114: Line 130:
!Protocol !! Syntax
!Protocol !! Syntax
|-
|-
|JSON||"TransmissionResults":"string"
|JSON||<code>"TransmissionResults":"'''''string'''''"</code>
|}
|}


Line 124: Line 140:
!Protocol !! Syntax
!Protocol !! Syntax
|-
|-
|JSON||"TransmissionReference":"string"
|JSON||<code>"TransmissionReference":"'''''string'''''"</code>
|}
|}


Line 134: Line 150:
!Protocol !! Syntax
!Protocol !! Syntax
|-
|-
|JSON||"Version":"string"
|JSON||<code>"Version":"'''''string'''''"</code>
|}
 
 
<h3 style="background-color:rgb(240,240,240);">TotalRecords</h3>
:The total number of records returned in the records array.
 
:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"TotalRecords":"'''''string'''''"</code>
|}
|}


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


Line 154: Line 180:
!Protocol !! Syntax
!Protocol !! Syntax
|-
|-
|JSON||"Results":"string"
|JSON||<code>"Results":"'''''string'''''"</code>
|}
|}


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


Line 174: 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 184: 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 204: Line 239:
!Protocol !! Syntax
!Protocol !! Syntax
|-
|-
|JSON||"City":"string"
|JSON||<code>"City":"'''''string'''''"</code>
|}
|}


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


Line 224: 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>
|}
 
 
<h3 style="background-color:rgb(240,240,240);">MelissaEnterpriseKey</h3>
:The Unique Key assigned to a business for that location.
 
:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"MelissaEnterpriseKey":"'''''string'''''"</code>
|}
|}


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


Line 260: Line 315:
!Protocol !! Syntax
!Protocol !! Syntax
|-
|-
|JSON||"Phone":"string"
|JSON||<code>"Phone":"'''''string'''''"</code>
|}
|}


Line 270: Line 325:
!Protocol !! Syntax
!Protocol !! Syntax
|-
|-
|JSON||"EmployeesEstimate":"string"
|JSON||<code>"EmployeesEstimate":"'''''string'''''"</code>
|}
|}




<h3 style="background-color:rgb(240,240,240);">SalesEstimate</h3>
<h3 style="background-color:rgb(240,240,240);">SalesEstimate</h3>
:The sales volume and/or assets of the business in thousands.
:The sales volume and/or assets of the business.


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


Line 290: Line 345:
!Protocol !! Syntax
!Protocol !! Syntax
|-
|-
|JSON||"StockTicker":"string"
|JSON||<code>"StockTicker":"'''''string'''''"</code>
|}
|}


Line 300: Line 355:
!Protocol !! Syntax
!Protocol !! Syntax
|-
|-
|JSON||"WebAddress":"string"
|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==
==GrpAddressDetails==
<h3 style="background-color:rgb(240,240,240);">Plus4</h3>
<h3 style="background-color:rgb(240,240,240);">CountryCode</h3>
:The Plus4 of the address.
:The 2-Character Country Code.
 
:{| class="alternate01"
!Protocol !! Syntax
|-
|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"
:{| class="alternate01"
!Protocol !! Syntax
!Protocol !! Syntax
|-
|-
|JSON||"Plus4":"string"
|JSON||<code>"CountryName":"'''''string'''''"</code>
|}
|}


Line 321: Line 406:
!Protocol !! Syntax
!Protocol !! Syntax
|-
|-
|JSON||"DeliveryIndicator":"string"
|JSON||<code>"DeliveryIndicator":"'''''string'''''"</code>
|}
|}


Line 331: Line 416:
!Protocol !! Syntax
!Protocol !! Syntax
|-
|-
|JSON||"MelissaAddressKey":"string"
|JSON||<code>"MelissaAddressKey":"'''''string'''''"</code>
|}
|}


Line 341: Line 426:
!Protocol !! Syntax
!Protocol !! Syntax
|-
|-
|JSON||"MelissaAddressKeyBase":"string"
|JSON||<code>"MelissaAddressKeyBase":"'''''string'''''"</code>
|}
 
 
<h3 style="background-color:rgb(240,240,240);">Plus4</h3>
:The Plus4 of the address.
 
:{| class="alternate01"
!Protocol !! Syntax
|-
|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"
!Protocol !! Syntax
|-
|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.
:A 6-digit SIC code for the business's primary line of business.


Line 352: Line 457:
!Protocol !! Syntax
!Protocol !! Syntax
|-
|-
|JSON||"SICCode":"string"
|JSON||<code>"SICCode1":"'''''string'''''"</code>
|}
|}


Line 362: Line 467:
!Protocol !! Syntax
!Protocol !! Syntax
|-
|-
|JSON||"SICCode2":"string"
|JSON||<code>"SICCode2":"'''''string'''''"</code>
|}
|}


Line 372: Line 477:
!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 [[#SICCode|SICCode]].
: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>
|}
|}


Line 392: Line 497:
!Protocol !! Syntax
!Protocol !! Syntax
|-
|-
|JSON||"NAICSCode2":"string"
|JSON||<code>"NAICSCode2":"'''''string'''''"</code>
|}
|}


Line 402: Line 507:
!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 [[#SICCode|SICCode]].
:First SIC code description. Related to [[#SICCode1|SICCode1]].


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


Line 423: Line 528:
!Protocol !! Syntax
!Protocol !! Syntax
|-
|-
|JSON||"SICDescription2":"string"
|JSON||<code>"SICDescription2":"'''''string'''''"</code>
|}
|}


Line 433: Line 538:
!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 [[#NAICSCode|NAICSCode]].
:First NAICS code description. Related to [[#NAICSCode1|NAICSCode1]].


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


Line 453: Line 558:
!Protocol !! Syntax
!Protocol !! Syntax
|-
|-
|JSON||"NAICSDescription2":"string"
|JSON||<code>"NAICSDescription2":"'''''string'''''"</code>
|}
|}


Line 463: Line 568:
!Protocol !! Syntax
!Protocol !! Syntax
|-
|-
|JSON||"NAICSDescription3":"string"
|JSON||<code>"NAICSDescription3":"'''''string'''''"</code>
|}
|}


Line 474: Line 579:
!Protocol !! Syntax
!Protocol !! Syntax
|-
|-
|JSON||"Latitude":"string"
|JSON||<code>"Latitude":"'''''string'''''"</code>
|}
|}


Line 484: Line 589:
!Protocol !! Syntax
!Protocol !! Syntax
|-
|-
|JSON||"Longitude":"string"
|JSON||<code>"Longitude":"'''''string'''''"</code>
|}
|}


Line 495: Line 600:
!Protocol !! Syntax
!Protocol !! Syntax
|-
|-
|JSON||"CountyName":"string"
|JSON||<code>"CountyName":"'''''string'''''"</code>
|}
|}


Line 505: Line 610:
!Protocol !! Syntax
!Protocol !! Syntax
|-
|-
|JSON||"CountyFIPS":"string"
|JSON||<code>"CountyFIPS":"'''''string'''''"</code>
|}
|}


Line 515: Line 620:
!Protocol !! Syntax
!Protocol !! Syntax
|-
|-
|JSON||"CensusTract":"string"
|JSON||<code>"CensusTract":"'''''string'''''"</code>
|}
|}


Line 525: Line 630:
!Protocol !! Syntax
!Protocol !! Syntax
|-
|-
|JSON||"CensusBlock":"string"
|JSON||<code>"CensusBlock":"'''''string'''''"</code>
|}
|}


Line 535: Line 640:
!Protocol !! Syntax
!Protocol !! Syntax
|-
|-
|JSON||"PlaceCode":"string"
|JSON||<code>"PlaceCode":"'''''string'''''"</code>
|}
|}


Line 545: Line 650:
!Protocol !! Syntax
!Protocol !! Syntax
|-
|-
|JSON||"PlaceName":"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"