Business Coder:Response: Difference between revisions

Revision as of 18:13, 7 January 2016

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 [Business Coder:Request#Column|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
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"

@@ Line 6: / Line 6: @@
 {{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==
 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"