Business Coder:Response: Difference between revisions
No edit summary |
No edit summary |
||
Line 205: | Line 205: | ||
<h3 style="background-color:rgb(240,240,240);">CurrentCompanyName</h3> | <h3 style="background-color:rgb(240,240,240);">CurrentCompanyName</h3> | ||
:The company name in our reference data. | :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" | :{| class="alternate01" | ||
!Protocol !! Syntax | !Protocol !! Syntax |
Latest revision as of 00:25, 9 December 2020
Business Coder Navigation | ||||
---|---|---|---|---|
| ||||
| ||||
| ||||
| ||||
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"