Business Search:Response: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
(One intermediate revision by the same user not shown) | |||
Line 1: | Line 1: | ||
{{ | {{BusinessSearchNav | ||
|InputOutputCollapse= | |InputOutputCollapse= | ||
}} | }} | ||
Line 121: | Line 121: | ||
==Response (Base Level)== | ==Response (Base Level)== | ||
<h3 style="background-color:rgb(240,240,240);">TransmissionResults</h3> | <h3 style="background-color:rgb(240,240,240);">TransmissionResults</h3> | ||
:This is a string value that lists result codes from the web service. For a complete list of result codes, see [[Result Code Details# | :This is a string value that lists result codes from the web service. For a complete list of result codes, see [[Result Code Details#Business Search|Business Search Result Codes]]. | ||
:{| class="alternate01" | :{| class="alternate01" | ||
Line 141: | Line 141: | ||
<h3 style="background-color:rgb(240,240,240);">TotalPages</h3> | <h3 style="background-color:rgb(240,240,240);">TotalPages</h3> | ||
:This is a string value containing the number of total pages returned by the request. The amount of records per page is set with the [[ | :This is a string value containing the number of total pages returned by the request. The amount of records per page is set with the [[Business Search:Request#RecordsPerPage|RecordsPerPage]] option. | ||
:{| class="alternate01" | :{| class="alternate01" | ||
Line 161: | Line 161: | ||
<h3 style="background-color:rgb(240,240,240);">Version</h3> | <h3 style="background-color:rgb(240,240,240);">Version</h3> | ||
:This is a string value that is the current revision number of | :This is a string value that is the current revision number of Business Search web service. | ||
:{| class="alternate01" | :{| class="alternate01" | ||
Line 184: | Line 184: | ||
:This is a string value that lists result codes for the current record. | :This is a string value that lists result codes for the current record. | ||
:For a complete list of result codes, see [[Result Code Details# | :For a complete list of result codes, see [[Result Code Details#Business Search|Business Search Result Codes]]. | ||
:{| class="alternate01" | :{| class="alternate01" | ||
Line 615: | Line 615: | ||
[[Category: | [[Category:Business Search]] | ||
[[Category:Reference]] | [[Category:Reference]] |
Latest revision as of 22:41, 26 June 2020
Business Search Navigation | |||
---|---|---|---|
| |||
| |||
| |||
| |||
Sample Code |
A response is the result of a request. This consists of returned result codes.
The web service returns back a response in a JSON format.
Field Names
This is a list of the response field names and their protocol naming conventions.
Field Name | Level | JSON |
---|---|---|
Transmission Results | Response (Base) | TransmissionResults |
Transmission Reference | TransmissionReference | |
Total Pages | TotalPages | |
Total Records | TotalRecords | |
Version | Version | |
Record ID | Records | RecordID |
Results | Results | |
Sources | Sources | |
Company Name | Company | CompanyName |
Stock Ticker | StockTicker | |
EIN | EIN | |
Melissa Enterprise Key | MelissaEnterpriseKey | |
URL | WebAddress | URL |
Address Line 1 | CurrentAddress | AddressLine1 |
Address Line 2 | AddressLine2 | |
Address Line 3 | AddressLine3 | |
Address Line 4 | AddressLine4 | |
Address Line 5 | AddressLine5 | |
Address Line 6 | AddressLine6 | |
Address Line 7 | AddressLine7 | |
Address Line 8 | AddressLine8 | |
Sub Premise | SubPremise | |
Locality | Locality | |
Administrative Area | AdministrativeArea | |
Postal Code | PostalCode | |
Country Name | CountryName | |
Country ISO 3166-1 Alpha-2 | CountryISO3166_1_Alpha2 | |
Melissa Address Key | MelissaAddressKey | |
Melissa Address Key Base | MelissaAddressKeyBase | |
Move Date | MoveDate | |
Address Line 1 | PreviousAddresses | AddressLine1 |
Address Line 2 | AddressLine2 | |
Address Line 3 | AddressLine3 | |
Address Line 4 | AddressLine4 | |
Address Line 5 | AddressLine5 | |
Address Line 6 | AddressLine6 | |
Address Line 7 | AddressLine7 | |
Address Line 8 | AddressLine8 | |
Sub Premise | SubPremise | |
Locality | Locality | |
Administrative Area | AdministrativeArea | |
Postal Code | PostalCode | |
Country Name | CountryName | |
Country ISO 3166-1 Alpha-2 | CountryISO3166_1_Alpha2 | |
Melissa Address Key | MelissaAddressKey | |
Melissa Address Key Base | MelissaAddressKeyBase | |
Move Date | MoveDate | |
Phone Number | PhoneRecords | PhoneNumber |
Response Elements
The following fields are in the response.
Response (Base Level)
TransmissionResults
- This is a string value that lists result codes from the web service. For a complete list of result codes, see Business Search Result Codes.
Protocol Syntax JSON "TransmissionResults":"string"
TransmissionReference
- This is a string value that serves as a unique identifier for this request. It is returned as sent in the request, allowing you to match the response to the request.
Protocol Syntax JSON "TransmissionReference":"string"
TotalPages
- This is a string value containing the number of total pages returned by the request. The amount of records per page is set with the RecordsPerPage option.
Protocol Syntax JSON "TotalPages":"string"
TotalRecords
- This is a string value containing the number of total records returned by the request, up to a maximum of 500.
Protocol Syntax JSON "TotalRecords":"string"
Version
- This is a string value that is the current revision number of Business Search web service.
Protocol Syntax JSON "Version":"string"
Records
RecordID
- This is a string value containing the record ID for the current record.
Protocol Syntax JSON "RecordID":"string"
Results
- This is a string value that lists result codes for the current record.
- For a complete list of result codes, see Business Search Result Codes.
Protocol Syntax JSON "Results":"string"
Sources
Protocol Syntax JSON "Sources":"string"
Company
- This returns an array of company information, containing the following field:
Field Name Company Name Stock Ticker EIN Melissa Enterprise Key
- For more information on these fields, see Company below.
Protocol Syntax JSON "Company":{array}
WebAddress
- This returns an array of web address records, containing the following field:
Field Name URL
- For more information on this field, see URL below.
Protocol Syntax JSON "WebAddress":{array}
CurrentAddress
- This returns an array of records for the current address, containing the following fields:
Field Name Address Line 1 Address Line 2 Address Line 3 Address Line 4 Address Line 5 Address Line 6 Address Line 7 Address Line 8 Sub Premise Locality Administrative Area Postal Code Country Name Country ISO 3166-1 Alpha-2 Melissa Address Key Melissa Address Key Base Move Date
- For more information on these fields, see CurrentAddress/PreviousAddresses below.
Protocol Syntax JSON "CurrentAddress":{array}
PreviousAddresses
- This returns an array of records for the previous address, containing the following fields:
Field Name Address Line 1 Address Line 2 Address Line 3 Address Line 4 Address Line 5 Address Line 6 Address Line 7 Address Line 8 Sub Premise Locality Administrative Area Postal Code Country Name Country ISO 3166-1 Alpha-2 Melissa Address Key Melissa Address Key Base Move Date
- For more information on these fields, see CurrentAddress/PreviousAddresses below.
Protocol Syntax JSON "PreviousAddresses":{array}
PhoneRecords
- This returns an array of phone records, containing the following field:
Field Name Phone Number
- For more information on this field, see PhoneNumber below.
Protocol Syntax JSON "PhoneRecords":{array}
Company
CompanyName
- This is a string value of the company name.
Protocol Syntax JSON "CompanyName":"string"
StockTicker
- This is a string value of the stock ticker, a unique abbreviation/symbol assigned by the stock exchange for listed companies.
Protocol Syntax JSON "StockTicker":"string"
EIN
- This is a string value of the EIN, the Employer Identification Number for the business.
Protocol Syntax JSON "EIN":"string"
MelissaEnterpriseKey
- This is a string value of the Melissa Enterprise Key, a unique key assigned to this business record.
Protocol Syntax JSON "MelissaEnterpriseKey":"string"
WebAddress
URL
- This is a string value of the web address URL.
Protocol Syntax JSON "URL":"string"
CurrentAddress/PreviousAddresses
AddressLine1
- These are the string values that will return the standardized or corrected contents of the input address. These lines will include the entire address including the locality, administrative area, and postal code.
Protocol Syntax JSON "AddressLine1":"string"
AddressLine2
- These are the string values that will return the standardized or corrected contents of the input address. These lines will include the entire address including the locality, administrative area, and postal code.
Protocol Syntax JSON "AddressLine2":"string"
AddressLine3
- These are the string values that will return the standardized or corrected contents of the input address. These lines will include the entire address including the locality, administrative area, and postal code.
Protocol Syntax JSON "AddressLine3":"string"
AddressLine4
- These are the string values that will return the standardized or corrected contents of the input address. These lines will include the entire address including the locality, administrative area, and postal code.
Protocol Syntax JSON "AddressLine4":"string"
AddressLine5
- These are the string values that will return the standardized or corrected contents of the input address. These lines will include the entire address including the locality, administrative area, and postal code.
Protocol Syntax JSON "AddressLine5":"string"
AddressLine6
- These are the string values that will return the standardized or corrected contents of the input address. These lines will include the entire address including the locality, administrative area, and postal code.
Protocol Syntax JSON "AddressLine6":"string"
AddressLine7
- These are the string values that will return the standardized or corrected contents of the input address. These lines will include the entire address including the locality, administrative area, and postal code.
Protocol Syntax JSON "AddressLine7":"string"
AddressLine8
- These are the string values that will return the standardized or corrected contents of the input address. These lines will include the entire address including the locality, administrative area, and postal code.
Protocol Syntax JSON "AddressLine8":"string"
SubPremise
- This is a string value of the sub premise. A sub premise is an individual unit with its own address inside a building.
Protocol Syntax JSON "SubPremise":"string"
Locality
- This is a string value of the locality. This is the most common geographic area and used by virtually all countries. This is usually the value that is written on a mailing label and referred to by terms like City, Town, Postal Town, etc.
Protocol Syntax JSON "Locality":"string"
AdministrativeArea
- This is a string value of the administrative area. This is a common geographic area unit for larger countries. Often referred to as State or Province.
Protocol Syntax JSON "AdministrativeArea":"string"
PostalCode
- This is a string value of the Postal Code. Most countries have some form of a postal code system.
Protocol Syntax JSON "PostalCode":"string"
CountryName
- This is a string value of the country name.
Protocol Syntax JSON "CountryName":"string"
CountryISO3166_1_Alpha2
- This is a string value of the 2 letter ISO 3166 country code value.
- For example:
Country Code United States US Canada CA Philippines PH
Protocol Syntax JSON "CountryISO3166_1_Alpha2":"string"
MelissaAddressKey
- This is a string value of the Melissa Address Key, a unique key assigned to this address record.
Protocol Syntax JSON "MelissaAddressKey":"string"
MelissaAddressKeyBase
- This is a string value of the Melissa Address Key Base, a unique key assigned to the base address of a complex with apartments or suites.
Protocol Syntax JSON "MelissaAddressKeyBase":"string"
MoveDate
- This is a string value of the move date associated with this individual and previous address.
Protocol Syntax JSON "MoveDate":"string"
PhoneRecords
PhoneNumber
- This is a string value listing the phone number.
Protocol Syntax JSON "PhoneNumber":"string"