Business Search:Response - Revision history

Admin at 22:41, 26 June 2020

2020-06-26T22:41:17Z

← Older revision		Revision as of 22:41, 26 June 2020
Line 1:		Line 1:
	{{~~GlobalBusinessSearchNav~~		{{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#~~Global~~ Business Search\|~~Global~~ Business Search Result Codes]].		: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 [[~~Global~~ Business Search:Request#RecordsPerPage\|RecordsPerPage]] option.		: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 ~~Global~~ Business Search web service.		: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#~~Global~~ Business Search\|~~Global~~ Business Search Result Codes]].		: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:~~Global~~ Business Search]]		[[Category:Business Search]]
	[[Category:Reference]]		[[Category:Reference]]

Admin: Admin moved page Global Business Search:Response to Business Search:Response

2020-06-26T22:40:26Z

Admin moved page Global Business Search:Response to Business Search:Response

← Older revision	Revision as of 22:40, 26 June 2020
(No difference)

Admin at 23:23, 10 August 2018

2018-08-10T23:23:58Z

← Older revision		Revision as of 23:23, 10 August 2018
Line 69:		Line 69:
	\|Country Name \|\| CountryName		\|Country Name \|\| CountryName
	\|-		\|-
	\|Country ISO 3166-1 Alpha-2 \|\| ~~CountryISO31661_1_Alpha2~~		\|Country ISO 3166-1 Alpha-2 \|\| CountryISO3166_1_Alpha2
	\|-		\|-
	\|Melissa Address Key \|\| MelissaAddressKey		\|Melissa Address Key \|\| MelissaAddressKey
Line 103:		Line 103:
	\|Country Name \|\| CountryName		\|Country Name \|\| CountryName
	\|-		\|-
	\|Country ISO 3166-1 Alpha-2 \|\| ~~CountryISO31661_1_Alpha2~~		\|Country ISO 3166-1 Alpha-2 \|\| CountryISO3166_1_Alpha2
	\|-		\|-
	\|Melissa Address Key \|\| MelissaAddressKey		\|Melissa Address Key \|\| MelissaAddressKey
Line 551:		Line 551:


	<h3 style="background-color:rgb(240,240,240);">~~CountryISO31661_1_Alpha2~~</h3>		<h3 style="background-color:rgb(240,240,240);">CountryISO3166_1_Alpha2</h3>
	:This is a string value of the 2 letter ISO 3166 country code value.		:This is a string value of the 2 letter ISO 3166 country code value.

Line 570:		Line 570:
	!Protocol !! Syntax		!Protocol !! Syntax
	\|-		\|-
	\|JSON\|\|<code>"~~CountryISO31661_1_Alpha2~~":"'''''string'''''"</code>		\|JSON\|\|<code>"CountryISO3166_1_Alpha2":"'''''string'''''"</code>
	\|}		\|}

Admin at 18:12, 11 July 2018

2018-07-11T18:12:09Z

← Older revision		Revision as of 18:12, 11 July 2018
Line 43:		Line 43:
	\|URL \|\| WebAddress \|\| URL		\|URL \|\| WebAddress \|\| URL
	\|-		\|-
	\|Address Line 1 \|\|rowspan="9" valign="center"\| CurrentAddress \|\| AddressLine1		\|Address Line 1 \|\|rowspan="17" valign="center"\| CurrentAddress \|\| AddressLine1
	\|-		\|-
	\|Address Line 2 \|\| AddressLine2		\|Address Line 2 \|\| AddressLine2
Line 77:		Line 77:
	\|Move Date \|\| MoveDate		\|Move Date \|\| MoveDate
	\|-		\|-
	\|Address Line 1 \|\|rowspan="9" valign="center"\| PreviousAddresses \|\| AddressLine1		\|Address Line 1 \|\|rowspan="17" valign="center"\| PreviousAddresses \|\| AddressLine1
	\|-		\|-
	\|Address Line 2 \|\| AddressLine2		\|Address Line 2 \|\| AddressLine2

Admin: Created page with "{{GlobalBusinessSearchNav |InputOutputCollapse= }} {{CustomTOC}} A response is the result of a request. This consists of returned result codes. The web service returns bac..."

2018-07-11T18:08:41Z

Created page with "{{GlobalBusinessSearchNav |InputOutputCollapse= }} {{CustomTOC}} A response is the result of a request. This consists of returned result codes. The web service returns bac..."

New page

{{GlobalBusinessSearchNav
|InputOutputCollapse=
}}

{{CustomTOC}}

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.

{| class="alternate01 sortable"
!Field Name !! Level !! JSON
|-
|Transmission Results ||rowspan="5" valign="center"| Response (Base) || TransmissionResults
|-
|Transmission Reference || TransmissionReference
|-
|Total Pages || TotalPages
|-
|Total Records || TotalRecords
|-
|Version || Version
|-
|Record ID ||rowspan="3" valign="center"| Records || RecordID
|-
|Results || Results
|-
|Sources || Sources
|-
|Company Name ||rowspan="4" valign="center"| Company || CompanyName
|-
|Stock Ticker || StockTicker
|-
|EIN || EIN
|-
|Melissa Enterprise Key || MelissaEnterpriseKey
|-
|URL || WebAddress || URL
|-
|Address Line 1 ||rowspan="9" valign="center"| 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 || CountryISO31661_1_Alpha2
|-
|Melissa Address Key || MelissaAddressKey
|-
|Melissa Address Key Base || MelissaAddressKeyBase
|-
|Move Date || MoveDate
|-
|Address Line 1 ||rowspan="9" valign="center"| 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 || CountryISO31661_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)==
<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#Global Business Search|Global Business Search Result Codes]].

:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"TransmissionResults":"'''''string'''''"</code>
|}

<h3 style="background-color:rgb(240,240,240);">TransmissionReference</h3>
: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.

:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"TransmissionReference":"'''''string'''''"</code>
|}

<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 [[Global Business Search:Request#RecordsPerPage|RecordsPerPage]] option.

:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"TotalPages":"'''''string'''''"</code>
|}

<h3 style="background-color:rgb(240,240,240);">TotalRecords</h3>
:This is a string value containing the number of total records returned by the request, up to a maximum of 500.

:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"TotalRecords":"'''''string'''''"</code>
|}

<h3 style="background-color:rgb(240,240,240);">Version</h3>
:This is a string value that is the current revision number of Global Business Search web service.

:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"Version":"'''''string'''''"</code>
|}

==Records==
<h3 style="background-color:rgb(240,240,240);">RecordID</h3>
:This is a string value containing the record ID for the current record.

:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"RecordID":"'''''string'''''"</code>
|}

<h3 style="background-color:rgb(240,240,240);">Results</h3>
:This is a string value that lists result codes for the current record.

:For a complete list of result codes, see [[Result Code Details#Global Business Search|Global Business Search Result Codes]].

:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"Results":"'''''string'''''"</code>
|}

<h3 style="background-color:rgb(240,240,240);">Sources</h3>
:

:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"Sources":"'''''string'''''"</code>
|}

<h3 style="background-color:rgb(240,240,240);">Company</h3>
:This returns an array of company information, containing the following field:

::{| class="alternate01"
!Field Name
|-
|Company Name
|-
|Stock Ticker
|-
|EIN
|-
|Melissa Enterprise Key
|}

:For more information on these fields, see [[#Company|Company]] below.

:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"Company":{'''''array'''''}</code>
|}

<h3 style="background-color:rgb(240,240,240);">WebAddress</h3>
:This returns an array of web address records, containing the following field:

::{| class="alternate01"
!Field Name
|-
|URL
|}

:For more information on this field, see [[#URL|URL]] below.

:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"WebAddress":{'''''array'''''}</code>
|}

<h3 style="background-color:rgb(240,240,240);">CurrentAddress</h3>
:This returns an array of records for the current address, containing the following fields:

::{| class="alternate01"
!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|CurrentAddress/PreviousAddresses]] below.

:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"CurrentAddress":{'''''array'''''}</code>
|}

<h3 style="background-color:rgb(240,240,240);">PreviousAddresses</h3>
:This returns an array of records for the previous address, containing the following fields:

::{| class="alternate01"
!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|CurrentAddress/PreviousAddresses]] below.

:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"PreviousAddresses":{'''''array'''''}</code>
|}

<h3 style="background-color:rgb(240,240,240);">PhoneRecords</h3>
:This returns an array of phone records, containing the following field:

::{| class="alternate01"
!Field Name
|-
|Phone Number
|}

:For more information on this field, see [[#PhoneNumber|PhoneNumber]] below.

:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"PhoneRecords":{'''''array'''''}</code>
|}

==Company==
<h3 style="background-color:rgb(240,240,240);">CompanyName</h3>
:This is a string value of the company name.

:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"CompanyName":"'''''string'''''"</code>
|}

<h3 style="background-color:rgb(240,240,240);">StockTicker</h3>
:This is a string value of the stock ticker, a unique abbreviation/symbol assigned by the stock exchange for listed companies.

:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"StockTicker":"'''''string'''''"</code>
|}

<h3 style="background-color:rgb(240,240,240);">EIN</h3>
:This is a string value of the EIN, the Employer Identification Number for the business.

:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"EIN":"'''''string'''''"</code>
|}

<h3 style="background-color:rgb(240,240,240);">MelissaEnterpriseKey</h3>
:This is a string value of the Melissa Enterprise Key, a unique key assigned to this business record.

:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"MelissaEnterpriseKey":"'''''string'''''"</code>
|}

==WebAddress==
<h3 style="background-color:rgb(240,240,240);">URL</h3>
:This is a string value of the web address URL.

:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"URL":"'''''string'''''"</code>
|}

==CurrentAddress/PreviousAddresses==
<h3 style="background-color:rgb(240,240,240);">AddressLine1</h3>
: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.

:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"AddressLine1":"'''''string'''''"</code>
|}

<h3 style="background-color:rgb(240,240,240);">AddressLine2</h3>
: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.

:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"AddressLine2":"'''''string'''''"</code>
|}

<h3 style="background-color:rgb(240,240,240);">AddressLine3</h3>
: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.

:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"AddressLine3":"'''''string'''''"</code>
|}

<h3 style="background-color:rgb(240,240,240);">AddressLine4</h3>
: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.

:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"AddressLine4":"'''''string'''''"</code>
|}

<h3 style="background-color:rgb(240,240,240);">AddressLine5</h3>
: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.

:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"AddressLine5":"'''''string'''''"</code>
|}

<h3 style="background-color:rgb(240,240,240);">AddressLine6</h3>
: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.

:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"AddressLine6":"'''''string'''''"</code>
|}

<h3 style="background-color:rgb(240,240,240);">AddressLine7</h3>
: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.

:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"AddressLine7":"'''''string'''''"</code>
|}

<h3 style="background-color:rgb(240,240,240);">AddressLine8</h3>
: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.

:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"AddressLine8":"'''''string'''''"</code>
|}

<h3 style="background-color:rgb(240,240,240);">SubPremise</h3>
:This is a string value of the sub premise. A sub premise is an individual unit with its own address inside a building.

:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"SubPremise":"'''''string'''''"</code>
|}

<h3 style="background-color:rgb(240,240,240);">Locality</h3>
: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.

:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"Locality":"'''''string'''''"</code>
|}

<h3 style="background-color:rgb(240,240,240);">AdministrativeArea</h3>
: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.

:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"AdministrativeArea":"'''''string'''''"</code>
|}

<h3 style="background-color:rgb(240,240,240);">PostalCode</h3>
:This is a string value of the Postal Code. Most countries have some form of a postal code system.

:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"PostalCode":"'''''string'''''"</code>
|}

<h3 style="background-color:rgb(240,240,240);">CountryName</h3>
:This is a string value of the country name.

:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"CountryName":"'''''string'''''"</code>
|}

<h3 style="background-color:rgb(240,240,240);">CountryISO31661_1_Alpha2</h3>
:This is a string value of the 2 letter ISO 3166 country code value.

:For example:

:{| class="alternate01"
!Country !! Code
|-
|United States||US
|-
|Canada||CA
|-
|Philippines||PH
|}

:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"CountryISO31661_1_Alpha2":"'''''string'''''"</code>
|}

<h3 style="background-color:rgb(240,240,240);">MelissaAddressKey</h3>
:This is a string value of the Melissa Address Key, a unique key assigned to this address record.

:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"MelissaAddressKey":"'''''string'''''"</code>
|}

<h3 style="background-color:rgb(240,240,240);">MelissaAddressKeyBase</h3>
: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.

:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"MelissaAddressKeyBase":"'''''string'''''"</code>
|}

<h3 style="background-color:rgb(240,240,240);">MoveDate</h3>
:This is a string value of the move date associated with this individual and '''previous address'''.

:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"MoveDate":"'''''string'''''"</code>
|}

==PhoneRecords==
<h3 style="background-color:rgb(240,240,240);">PhoneNumber</h3>
:This is a string value listing the phone number.

:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"PhoneNumber":"'''''string'''''"</code>
|}

[[Category:Global Business Search]]
[[Category:Reference]]