Difference between revisions of "Business Coder:Response"

From Melissa Data Wiki
Jump to navigation Jump to search
Line 19: Line 19:
!Field Name !! Group
!Field Name !! Group
|-
|-
|LocationType||rowspan="6"|'''[NO GROUP]'''
|TransmissionResults||rowspan="12"|'''[DEFAULT]'''
These columns must be requested individually.
Always return in the output structure.
|-
|-
|Phone
|TransmissionReference
|-
|-
|StockTicker
|Version
|-
|-
|WebAddress
|Records
|-
|-
|EmployeesEstimate
|Results
|-
|-
|SalesEstimate
|RecordID
|-
|-
|CompanyName||rowspan="6"|'''[DEFAULT]'''
|CompanyName
Always return in the output structure.
|-
|-
|AddressLine1
|AddressLine1
Line 44: Line 43:
|-
|-
|PostalCode
|PostalCode
|-
|LocationType||rowspan="6"|'''[NO GROUP]'''
These columns must be requested individually.
|-
|Phone
|-
|EmployeesEstimate
|-
|SalesEstimate
|-
|StockTicker
|-
|WebAddress
|-
|-
|FemaleOwned||rowspan="3"|'''GrpBusinessInfo'''
|FemaleOwned||rowspan="3"|'''GrpBusinessInfo'''
Line 77: Line 89:




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


:{| class="alternate01"
:{| class="alternate01"
!Protocol !! Syntax
!Protocol !! Syntax
|-
|-
|JSON||"LocationType":"string"
|JSON||"TransmissionResults":"string"
|}
|}




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


:{| class="alternate01"
:{| class="alternate01"
!Protocol !! Syntax
!Protocol !! Syntax
|-
|-
|JSON||"Phone":"string"
|JSON||"TransmissionReference":"string"
|}
|}




<h3 style="background-color:rgb(240,240,240);">StockTicker</h3>
<h3 style="background-color:rgb(240,240,240);">Version</h3>
:The assigned stock exchange abbreviation/symbol for the business.
:The current web service version.


:{| class="alternate01"
:{| class="alternate01"
!Protocol !! Syntax
!Protocol !! Syntax
|-
|-
|JSON||"StockTicker":"string"
|JSON||"Version":"string"
|}
|}




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


:{| class="alternate01"
:{| class="alternate01"
!Protocol !! Syntax
!Protocol !! Syntax
|-
|-
|JSON||"WebAddress":"string"
|JSON||"Records":"string"
|}
|}




<h3 style="background-color:rgb(240,240,240);">EmployeesEstimate</h3>
<h3 style="background-color:rgb(240,240,240);">Results</h3>
:The number of employees who work at this business location.
: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||"Results":"string"
|}
|}




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


:{| class="alternate01"
:{| class="alternate01"
!Protocol !! Syntax
!Protocol !! Syntax
|-
|-
|JSON||"SalesEstimate":"string"
|JSON||"RecordID":"string"
|}
|}




==[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 211: Line 207:
|-
|-
|JSON||"PostalCode":"string"
|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.
<h3 style="background-color:rgb(240,240,240);">LocationType</h3>
:Code denoting the business location type.
:{| class="alternate01"
!Code !! Definition
|-
|{blank}||Single Location
|-
|1||Headquarters
|-
|2||Branches
|-
|3||Subsidiary Headquarters
|}
:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||"LocationType":"string"
|}
<h3 style="background-color:rgb(240,240,240);">Phone</h3>
:10-digit phone number.
:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||"Phone":"string"
|}
<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||"EmployeesEstimate":"string"
|}
<h3 style="background-color:rgb(240,240,240);">SalesEstimate</h3>
:The sales volume and/or assets of the business in thousands.
:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||"SalesEstimate":"string"
|}
<h3 style="background-color:rgb(240,240,240);">StockTicker</h3>
:The assigned stock exchange abbreviation/symbol for the business.
:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||"StockTicker":"string"
|}
<h3 style="background-color:rgb(240,240,240);">WebAddress</h3>
:The web address/domain for the business.
:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||"WebAddress":"string"
|}
|}


Line 319: Line 391:
!Protocol !! Syntax
!Protocol !! Syntax
|-
|-
|JSON||"NAICSCode":"string"
|JSON||"NAICSCode2":"string"
|}
|}


Revision as of 18:13, 7 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 Bussiness details.

IP Locator 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 [Business Coder:Request#Column|Column] input. Specifying a gropu 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
FemaleOwned GrpBusinessInfo
SmallBusiness
HomeBasedBusiness
SICCode GrpBusinessCodes
SICCode2
SICCode3
NAICSCode
NAICSCode2
NAICSCode3
SICDescription GrpBusinessDescription
SICDescription2
SICDescription3
NAICSDescription
NAICSDescription2
NAICSDescription3


[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"


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"
Retrieved from "http://wiki.melissadata.com/index.php?title=Business_Coder:Response&oldid=10418"