Business Coder:Response: Difference between revisions

From Melissa Data Wiki
Jump to navigation Jump to search
← Older editNewer edit →
No edit summary
No edit summary
Line 56: Line 56:
|-
|-
|WebAddress
|WebAddress
|-
|Plus4||rowspan="4"|'''GrpAddressDetails'''
|-
|DeliveryIndicator
|-
|MelissaAddressKey
|-
|MelissaAddressKeyBase
|-
|-
|FemaleOwned||rowspan="3"|'''GrpBusinessInfo'''
|FemaleOwned||rowspan="3"|'''GrpBusinessInfo'''
Line 86: Line 94:
|-
|-
|NAICSDescription3
|NAICSDescription3
|-
|Latitude||rowspan="2"|'''GrpGeoCode'''
|-
|Longitude
|-
|CountyName||rowspan="6"|'''GrpCensus'''
|-
|CountyFIPS
|-
|CensusTract
|-
|CensusBlock
|-
|PlaceCode
|-
|PlaceName
|}
|}


Line 283: Line 307:
|-
|-
|JSON||"WebAddress":"string"
|JSON||"WebAddress":"string"
|}
==GrpAddressDetails==
<h3 style="background-color:rgb(240,240,240);">Plus4</h3>
:The Plus4 of the address.
:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||"Plus4":"string"
|}
<h3 style="background-color:rgb(240,240,240);">DeliveryIndicator</h3>
:The RBDI Indicator based on the address.
:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||"DeliveryIndicator":"string"
|}
<h3 style="background-color:rgb(240,240,240);">MelissaAddressKey</h3>
:(MAK) A unique key assigned to an address record.
:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||"MelissaAddressKey":"string"
|}
<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
|-
|JSON||"MelissaAddressKeyBase":"string"
|}
|}


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


Revision as of 22:18, 8 January 2016

← 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
Records
Results
RecordID
CompanyName
AddressLine1
Suite
City
State
PostalCode
LocationType [NO GROUP]

These columns must be requested individually.

Phone
EmployeesEstimate
SalesEstimate
StockTicker
WebAddress
Plus4 GrpAddressDetails
DeliveryIndicator
MelissaAddressKey
MelissaAddressKeyBase
FemaleOwned GrpBusinessInfo
SmallBusiness
HomeBasedBusiness
SICCode GrpBusinessCodes
SICCode2
SICCode3
NAICSCode
NAICSCode2
NAICSCode3
SICDescription GrpBusinessDescription
SICDescription2
SICDescription3
NAICSDescription
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"


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"


AddressLine1

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


Suite

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"


[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
{blank} Single Location
1 Headquarters
2 Branches
3 Subsidiary Headquarters


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 in thousands.
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"


GrpAddressDetails

Plus4

The Plus4 of the address.
Protocol Syntax
JSON "Plus4":"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"


GrpBusinessInfo

FemaleOwned

Indicates if the business is owned by a female.
Code Definition
{blank} No
1 Yes


Protocol Syntax
JSON "FemaleOwned":"string"


SmallBusiness

Indicates if the business is a small business.
Code Definition
0 No
1 Yes


Protocol Syntax
JSON "SmallBusiness":"string"


HomeBasedBusiness

Indicates if the business is a home business.
Code Definition
{blank} No
1 Yes


Protocol Syntax
JSON "HomeBasedBusiness":"string"


GrpBusinessCodes

SICCode

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


SICCode2

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


SICCode3

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


NAICSCode

North American Industry Classification System code. This is related to SICCode.
Protocol Syntax
JSON "NAICSCode":"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

SICDescription

First SIC code description. Related to SICCode.
Protocol Syntax
JSON "SICDescription":"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"


NAICSDescription

First NAICS code description. Related to NAICSCode.
Protocol Syntax
JSON "NAICSDescription":"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=10433"