Business Coder UK:Response: Difference between revisions

From Melissa Data Wiki
Jump to navigation Jump to search
Created page with "{{BusinessCoderUKNav |InputOutputCollapse= }} {{CustomTOC}} A response is the result of a request. This consists of returned results codes and Business details. Business C..."
 
No edit summary
 
(4 intermediate revisions by the same user not shown)
Line 58: Line 58:
|Results
|Results
|-
|-
|AddressType||rowspan="27"|'''GrpAddressDetails'''
|Building||rowspan="26"|'''GrpAddressDetails'''
|-
|Building
|-
|-
|CountryCode
|CountryCode
Line 72: Line 70:
|DependentThoroughfare
|DependentThoroughfare
|-
|-
|DependentThoroughfareLeadinType
|DependentThoroughfareLeadingType
|-
|-
|DependentThoroughfareName
|DependentThoroughfareName
Line 102: Line 100:
|Thoroughfare
|Thoroughfare
|-
|-
|ThoroughfareLeadinType
|ThoroughfareLeadingType
|-
|-
|ThoroughfareName
|ThoroughfareName
Line 257: Line 255:




<h3 style="background-color:rgb(240,240,240);">CountryName</h3>
<h3 style="background-color:rgb(240,240,240);">FormattedAddress</h3>
:The country name, abbreviation, or code.
:Mailing address. The full mailing address in the preferred format for the country of the address.


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


Line 328: Line 326:


==GrpAddressDetails==
==GrpAddressDetails==
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);">Building</h3>
 
:Descriptive name identifying an individual location.
<h3 style="background-color:rgb(240,240,240);"></h3>
:


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




<h3 style="background-color:rgb(240,240,240);"></h3>
:
:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"":"'''''string'''''"</code>
|}
==GrpAddressDetails==
<h3 style="background-color:rgb(240,240,240);">CountryCode</h3>
<h3 style="background-color:rgb(240,240,240);">CountryCode</h3>
:The 2-Character Country Code.
:The 2-Character Country Code.
Line 381: Line 366:




<h3 style="background-color:rgb(240,240,240);"></h3>
<h3 style="background-color:rgb(240,240,240);">DependentLocality</h3>
:
:A dependent locality is a logical area unit that is smaller than a locality but larger than a double dependent locality or thoroughfare. It can often be associated with a neighborhood or sector.


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




<h3 style="background-color:rgb(240,240,240);"></h3>
<h3 style="background-color:rgb(240,240,240);">DependentThoroughfare</h3>
:
:The dependent thoroughfare is a second thoroughfare that is required to narrow down the final address. This is rarely used.


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




<h3 style="background-color:rgb(240,240,240);"></h3>
<h3 style="background-color:rgb(240,240,240);">DependentThoroughfareLeadingType</h3>
:
:Dependent thoroughfare type that is placed before the dependent thoroughfare. This value is a part of the DependentThoroughfare field.


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




<h3 style="background-color:rgb(240,240,240);"></h3>
<h3 style="background-color:rgb(240,240,240);">DependentThoroughfareName</h3>
:
:Dependent thoroughfare name. This value is a part of the DependentThoroughfare field.


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




<h3 style="background-color:rgb(240,240,240);"></h3>
<h3 style="background-color:rgb(240,240,240);">DependentThoroughfarePostDirection</h3>
:
:Directional information placed after the dependent thoroughfare. This value is a part of the DependentThoroughfare field.


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




<h3 style="background-color:rgb(240,240,240);"></h3>
<h3 style="background-color:rgb(240,240,240);">DependentThoroughfarePreDirection</h3>
:
:Directional information placed before the dependent thoroughfare. This value is a part of the DependentThoroughfare field.


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




<h3 style="background-color:rgb(240,240,240);"></h3>
<h3 style="background-color:rgb(240,240,240);">DependentThoroughfareTrailingType</h3>
:
:Dependent thoroughfare type that is placed after the dependent thoroughfare. This value is a part of the DependentThoroughfare field.


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




<h3 style="background-color:rgb(240,240,240);"></h3>
<h3 style="background-color:rgb(240,240,240);">DoubleDependentLocality</h3>
:
:A double dependent locality is a logical area unit that is smaller than a dependent locality but bigger than a thoroughfare. This field is very rarely used.


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




<h3 style="background-color:rgb(240,240,240);"></h3>
<h3 style="background-color:rgb(240,240,240);">PostBox</h3>
:
:Post box information for a particular delivery point.


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




<h3 style="background-color:rgb(240,240,240);"></h3>
<h3 style="background-color:rgb(240,240,240);">PremisesNumber</h3>
:
:Number for a particular portion of a building.


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




<h3 style="background-color:rgb(240,240,240);"></h3>
<h3 style="background-color:rgb(240,240,240);">PremisesType</h3>
:
:Type for a particular portion of a building.


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




<h3 style="background-color:rgb(240,240,240);"></h3>
<h3 style="background-color:rgb(240,240,240);">SubAdministrativeArea</h3>
:
:This is a logical area that that is smaller than the administrative area but larger than a locality. While many countries can have a sub-administrative area value, it is very rarely used as part of an official address.


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




<h3 style="background-color:rgb(240,240,240);"></h3>
<h3 style="background-color:rgb(240,240,240);">SubNationalArea</h3>
:
:A sub-national area is a logical area unit that is larger than an administrative area but smaller than the country itself. It is extremely rarely used.


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




<h3 style="background-color:rgb(240,240,240);"></h3>
<h3 style="background-color:rgb(240,240,240);">SubPremises</h3>
:
:Subpremises are individual units with their own addresses inside a building.


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




<h3 style="background-color:rgb(240,240,240);"></h3>
<h3 style="background-color:rgb(240,240,240);">SubPremisesNumber</h3>
:
:Parsed number from the SubPremises field.


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




<h3 style="background-color:rgb(240,240,240);"></h3>
<h3 style="background-color:rgb(240,240,240);">SubPremisesType</h3>
:
:Parsed type from the SubPermises field.


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




<h3 style="background-color:rgb(240,240,240);"></h3>
<h3 style="background-color:rgb(240,240,240);">Thoroughfare</h3>
:
:This is a part of the address lines and contains all the sub-elements of the thoroughfare like trailing type, thoroughfare name, pre direction, post direction, etc.


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




<h3 style="background-color:rgb(240,240,240);"></h3>
<h3 style="background-color:rgb(240,240,240);">ThoroughfareLeadingType</h3>
:
:Thoroughfare type that is placed before the thoroughfare. This value is a part of the Thoroughfare field.


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




<h3 style="background-color:rgb(240,240,240);"></h3>
<h3 style="background-color:rgb(240,240,240);">ThoroughfareName</h3>
:
:Thoroughfare name. This value is a part of the Thoroughfare field.


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




<h3 style="background-color:rgb(240,240,240);"></h3>
<h3 style="background-color:rgb(240,240,240);">ThoroughfarePostDirection</h3>
:
:Directional information placed after the thoroughfare. This value is a part of the Thoroughfare field.


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




<h3 style="background-color:rgb(240,240,240);">ThoroughfarePreDirection</h3>
<h3 style="background-color:rgb(240,240,240);">ThoroughfarePreDirection</h3>
:Thoroughfare directional information placed before the thoroughfare. This value is a part of the Thoroughfare field.
:Directional information placed before the thoroughfare. This value is a part of the Thoroughfare field.


:{| class="alternate01"
:{| class="alternate01"
Line 592: Line 577:


<h3 style="background-color:rgb(240,240,240);">ThoroughfareTrailingType</h3>
<h3 style="background-color:rgb(240,240,240);">ThoroughfareTrailingType</h3>
:A thoroughfare type that is placed after the thoroughfare. This value is a part of the Thoroughfare field.
:Thoroughfare type that is placed after the thoroughfare. This value is a part of the Thoroughfare field.


:{| class="alternate01"
:{| class="alternate01"

Latest revision as of 18:50, 13 October 2017

← Business Coder UK

Business Coder UK Navigation
Introduction
Licensing
Input/Output
Request Fields
Response Fields
Examples
REST JSON
JSON
Business Coder UK Result Codes
Sample Code



A response is the result of a request. This consists of returned results codes and Business details.

Business Coder UK 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.

TranmissionReference
Version
TotalRecords
Records
AddressLine1
AddressLine2
AddressLine3
AddressLine4
AdministrativeArea
CompanyName
CountryName
FormattedAddress
Locality
MelissaAddressKey
MelissaAddressKeyBase
PostalCode
RecordID
Results
Building GrpAddressDetails
CountryCode
CountyName
DeliveryIndicator
DependentLocality
DependentThoroughfare
DependentThoroughfareLeadingType
DependentThoroughfareName
DependentThoroughfarePostDirection
DependentThoroughfarePreDirection
DependentThoroughfareTrailingType
DoubleDependentLocality
PostBox
PremisesNumber
PremisesType
SubAdministrativeArea
SubNationalArea
SubPremises
SubPremisesNumber
SubPremisesType
Thoroughfare
ThoroughfareLeadingType
ThoroughfareName
ThoroughfarePostDirection
ThoroughfarePreDirection
ThoroughfareTrailingType
IncorporationDate GrpFirmographics
SICCode1
SICCode2
SICCode3
SICCode4
SICDescription1
SICDescription2
SICDescription3
SICDescription4
Latitude GrpGeoCode
Longitude


[DEFAULT]

TransmissionResults

Returns the generic web service level result/error codes. For more information, see Business Coder UK 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"


AddressLine1

Address Line 1 of the business.
Protocol Syntax
JSON "AddressLine1":"string"


AddressLine2

Address Line 2 of the business.
Protocol Syntax
JSON "AddressLine2":"string"


AddressLine3

Address Line 3 of the business.
Protocol Syntax
JSON "AddressLine3":"string"


AddressLine4

Address Line 4 of the business.
Protocol Syntax
JSON "AddressLine4":"string"


AdministrativeArea

The most common geographic data element.
Protocol Syntax
JSON "AdministrativeArea":"string"


CompanyName

Name of the business.
Protocol Syntax
JSON "CompanyName":"string"


CountryName

The country name, abbreviation, or code.
Protocol Syntax
JSON "CountryName":"string"


FormattedAddress

Mailing address. The full mailing address in the preferred format for the country of the address.
Protocol Syntax
JSON "FormattedAddress":"string"


Locality

The most common population center data element.
Protocol Syntax
JSON "Locality":"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"


PostalCode

Postal Code of the business.
Protocol Syntax
JSON "PostalCode":"string"


RecordID

Position of the record in the response array.
Protocol Syntax
JSON "RecordID":"string"


Results

Returns record specific result codes. For more information, see Business Coder UK Result Codes.
Protocol Syntax
JSON "Results":"string"


GrpAddressDetails

Building

Descriptive name identifying an individual location.
Protocol Syntax
JSON "Building":"string"


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"


DependentLocality

A dependent locality is a logical area unit that is smaller than a locality but larger than a double dependent locality or thoroughfare. It can often be associated with a neighborhood or sector.
Protocol Syntax
JSON "DependentLocality":"string"


DependentThoroughfare

The dependent thoroughfare is a second thoroughfare that is required to narrow down the final address. This is rarely used.
Protocol Syntax
JSON "DependentThoroughfare":"string"


DependentThoroughfareLeadingType

Dependent thoroughfare type that is placed before the dependent thoroughfare. This value is a part of the DependentThoroughfare field.
Protocol Syntax
JSON "DependentThoroughfareLeadingType":"string"


DependentThoroughfareName

Dependent thoroughfare name. This value is a part of the DependentThoroughfare field.
Protocol Syntax
JSON "DependentThoroughfareName":"string"


DependentThoroughfarePostDirection

Directional information placed after the dependent thoroughfare. This value is a part of the DependentThoroughfare field.
Protocol Syntax
JSON "DependentThoroughfarePostDirection":"string"


DependentThoroughfarePreDirection

Directional information placed before the dependent thoroughfare. This value is a part of the DependentThoroughfare field.
Protocol Syntax
JSON "DependentThoroughfarePreDirection":"string"


DependentThoroughfareTrailingType

Dependent thoroughfare type that is placed after the dependent thoroughfare. This value is a part of the DependentThoroughfare field.
Protocol Syntax
JSON "DependentThoroughfareTrailingType":"string"


DoubleDependentLocality

A double dependent locality is a logical area unit that is smaller than a dependent locality but bigger than a thoroughfare. This field is very rarely used.
Protocol Syntax
JSON "DoubleDependentLocality":"string"


PostBox

Post box information for a particular delivery point.
Protocol Syntax
JSON "PostBox":"string"


PremisesNumber

Number for a particular portion of a building.
Protocol Syntax
JSON "PremisesNumber":"string"


PremisesType

Type for a particular portion of a building.
Protocol Syntax
JSON "PremisesType":"string"


SubAdministrativeArea

This is a logical area that that is smaller than the administrative area but larger than a locality. While many countries can have a sub-administrative area value, it is very rarely used as part of an official address.
Protocol Syntax
JSON "SubAdministrativeArea":"string"


SubNationalArea

A sub-national area is a logical area unit that is larger than an administrative area but smaller than the country itself. It is extremely rarely used.
Protocol Syntax
JSON "SubNationalArea":"string"


SubPremises

Subpremises are individual units with their own addresses inside a building.
Protocol Syntax
JSON "SubPremises":"string"


SubPremisesNumber

Parsed number from the SubPremises field.
Protocol Syntax
JSON "SubPremisesNumber":"string"


SubPremisesType

Parsed type from the SubPermises field.
Protocol Syntax
JSON "SubPremisesType":"string"


Thoroughfare

This is a part of the address lines and contains all the sub-elements of the thoroughfare like trailing type, thoroughfare name, pre direction, post direction, etc.
Protocol Syntax
JSON "Thoroughfare":"string"


ThoroughfareLeadingType

Thoroughfare type that is placed before the thoroughfare. This value is a part of the Thoroughfare field.
Protocol Syntax
JSON "ThoroughfareLeadingType":"string"


ThoroughfareName

Thoroughfare name. This value is a part of the Thoroughfare field.
Protocol Syntax
JSON "ThoroughfareName":"string"


ThoroughfarePostDirection

Directional information placed after the thoroughfare. This value is a part of the Thoroughfare field.
Protocol Syntax
JSON "ThoroughfarePostDirection":"string"


ThoroughfarePreDirection

Directional information placed before the thoroughfare. This value is a part of the Thoroughfare field.
Protocol Syntax
JSON "ThoroughfarePreDirection":"string"


ThoroughfareTrailingType

Thoroughfare type that is placed after the thoroughfare. This value is a part of the Thoroughfare field.
Protocol Syntax
JSON "ThoroughfareTrailingType":"string"


GrpFirmographics

IncorporationDate

The year the business was incorporated (started).
Protocol Syntax
JSON "IncorporationDate":"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"


SICCode4

The fourth SIC code.
Protocol Syntax
JSON "SICCode3":"string"


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"


SICDescription4

Fourth SIC code description. Related to SICCode4.
Protocol Syntax
JSON "SICDescription4":"string"


GrpGeoCode

Latitude

The latitude geo coordinate.
Protocol Syntax
JSON "Latitude":"string"


Longitude

The longitude geo coordinate.
Protocol Syntax
JSON "Longitude":"string"
Retrieved from "http://wiki.melissadata.com/index.php?title=Business_Coder_UK:Response&oldid=13404"