Business Coder UK:Request: Difference between revisions

From Melissa Data Wiki
Jump to navigation Jump to search
← Older edit
No edit summary
No edit summary
 
(5 intermediate revisions by the same user not shown)
Line 9: Line 9:


Business Coder UK supports the JSON and REST protocols to access the service.
Business Coder UK supports the JSON and REST protocols to access the service.
==URL==
{{URL-BusinessCoderUK}}




Line 17: Line 21:
!Field Name !! Level !! REST !! JSON
!Field Name !! Level !! REST !! JSON
|-
|-
|Transmission Reference||rowspan="5" valign="center"|Request||t||t
|Transmission Reference||rowspan="5" valign="center"|Request||t||TransmissionReference
|-
|-
|License Key||id||id
|License Key||id||CustomerID
|-
|-
|Column||cols||cols
|Column||cols||Columns
|-
|-
|Options||opt||opt
|Options||opt||Options
|-
|-
|Format||format||format
|Format||format||Format
|-
|-
|Record ID||rowspan="15"|Record||rec||rec
|Record ID||rowspan="15"|Record||rec||RecordID
|-
|-
|Company Name||comp||comp
|Company Name||comp||Company
|-
|-
|Address Line 1||a1||a1
|Address Line 1||a1||AddressLine1
|-
|-
|Address Line 2||a2||a2
|Address Line 2||a2||AddressLine2
|-
|-
|Address Line 3||a3||a3
|Address Line 3||a3||AddressLine3
|-
|-
|Address Line 4||a4||a4
|Address Line 4||a4||AddressLine4
|-
|-
|Locality||loc||loc
|Locality||loc||Locality
|-
|-
|Dependent Locality||dloc||dloc
|Dependent Locality||dloc||DependentLocality
|-
|-
|Double Dependent Locality||ddloc||ddloc
|Double Dependent Locality||ddloc||DoubleDependentLocality
|-
|-
|Administrative Area||area||area
|Sub Administrative Area||sarea||SubAdministrativeArea
|-
|-
|Sub Administrative Area||sarea||sarea
|Administrative Area||area||AdministrativeArea
|-
|-
|Postal Code||postal||postal
|Sub National Area||subnat||SubNationalArea
|-
|-
|Sub National Area||subnat||subnat
|Postal Code||postal||PostalCode
|-
|-
|Country||ctry||ctry
|Country||ctry||Country
|-
|-
|Melissa Address Key (MAK)||mak||mak
|Melissa Address Key (MAK)||mak||MelissaAddressKey
|}
|}


Line 77: Line 81:
!Protocol !! Syntax
!Protocol !! Syntax
|-
|-
|JSON||<code>"t":"'''''string'''''"</code>
|JSON||<code>"TransmissionReference":"'''''string'''''"</code>
|-
|-
|REST||<code>?t = '''''string'''''</code>
|REST||<code>?t = '''''string'''''</code>
Line 93: Line 97:
!Protocol !! Syntax
!Protocol !! Syntax
|-
|-
|JSON||<code>"id":"'''''string'''''"</code>
|JSON||<code>"CustomerID":"'''''string'''''"</code>
|-
|-
|REST||<code>&id = '''''string'''''</code>
|REST||<code>&id = '''''string'''''</code>
Line 107: Line 111:
!Protocol !! Syntax
!Protocol !! Syntax
|-
|-
|JSON||<code>"cols":"'''''string'''''"</code>
|JSON||<code>"Columns":"'''''string'''''"</code>
|-
|-
|REST||<code>&cols = '''''string'''''</code>
|REST||<code>&cols = '''''string'''''</code>
Line 113: Line 117:




Entering the column name to return the column. Specifying a group name will return all columns in the group.
:Entering the column name will return the column. Specifying a group name will return all columns in the group.
 
:List multiple columns in the following format, with multiple options delimited with a ",".
 
:{| class="alternate01"
!Syntax
|-
|<code>''ColumnName'',''ColumnName'',''ColumnName''</code>
|}
 


:{| class="alternate01 sortable"
:{| class="alternate01 sortable"
Line 233: Line 246:
!Protocol !! Syntax
!Protocol !! Syntax
|-
|-
|JSON||<code>"opt":"'''''string'''''"</code>
|JSON||<code>"Options":"'''''string'''''"</code>
|-
|-
|REST||<code>&opt = '''''string'''''</code>
|REST||<code>&opt = '''''string'''''</code>
Line 245: Line 258:
|-
|-
|<code>''OptionName'':''Parameter''</code>
|<code>''OptionName'':''Parameter''</code>
|}
:<h4 style="border-bottom:1px solid black;">ReturnDominantBusiness</h4>
::This option handles the returning of the dominant business name and demographics for a particular site when the company information is missing or does not match.
::{| class="alternate01 sortable"
!Option Name !! Parameter !! Description
|-
|rowspan="2"|'''ReturnDominantBusiness'''||<code>yes</code>||'''''Default.''''' Return the dominant business name when the company information is missing or does not match.
|-
|<code>no</code>||Do not return the dominant business name when the company information is missing or does not match.
|}
|}


Line 268: Line 269:
!Protocol !! Syntax
!Protocol !! Syntax
|-
|-
|JSON||<code>"format":"'''''string'''''"</code>
|JSON||<code>"Format":"'''''string'''''"</code>
|-
|-
|REST||<code>&format = '''''string'''''</code>
|REST||<code>&format = '''''string'''''</code>
Line 294: Line 295:
!Protocol !! Syntax
!Protocol !! Syntax
|-
|-
|JSON||<code>"rec":"'''''string'''''"</code>
|JSON||<code>"RecordID":"'''''string'''''"</code>
|-
|-
|REST||<code>&rec = '''''string'''''</code>
|REST||<code>&rec = '''''string'''''</code>
Line 308: Line 309:
!Protocol !! Syntax
!Protocol !! Syntax
|-
|-
|JSON||<code>"comp":"'''''string'''''"</code>
|JSON||<code>"Company":"'''''string'''''"</code>
|-
|-
|REST||<code>&comp = '''''string'''''</code>
|REST||<code>&comp = '''''string'''''</code>
Line 322: Line 323:
!Protocol !! Syntax
!Protocol !! Syntax
|-
|-
|JSON||<code>"a1":"'''''string'''''"</code>
|JSON||<code>"AddressLine1":"'''''string'''''"</code>
|-
|-
|REST||<code>&a1 = '''''string'''''</code>
|REST||<code>&a1 = '''''string'''''</code>
Line 336: Line 337:
!Protocol !! Syntax
!Protocol !! Syntax
|-
|-
|JSON||<code>"a2":"'''''string'''''"</code>
|JSON||<code>"AddressLine2":"'''''string'''''"</code>
|-
|-
|REST||<code>&a2 = '''''string'''''</code>
|REST||<code>&a2 = '''''string'''''</code>
Line 350: Line 351:
!Protocol !! Syntax
!Protocol !! Syntax
|-
|-
|JSON||<code>"a3":"'''''string'''''"</code>
|JSON||<code>"AddressLine3":"'''''string'''''"</code>
|-
|-
|REST||<code>&a3 = '''''string'''''</code>
|REST||<code>&a3 = '''''string'''''</code>
Line 364: Line 365:
!Protocol !! Syntax
!Protocol !! Syntax
|-
|-
|JSON||<code>"a4":"'''''string'''''"</code>
|JSON||<code>"AddressLine4":"'''''string'''''"</code>
|-
|-
|REST||<code>&a4 = '''''string'''''</code>
|REST||<code>&a4 = '''''string'''''</code>
Line 378: Line 379:
!Protocol !! Syntax
!Protocol !! Syntax
|-
|-
|JSON||<code>"loc":"'''''string'''''"</code>
|JSON||<code>"Locality":"'''''string'''''"</code>
|-
|-
|REST||<code>&loc = '''''string'''''</code>
|REST||<code>&loc = '''''string'''''</code>
Line 392: Line 393:
!Protocol !! Syntax
!Protocol !! Syntax
|-
|-
|JSON||<code>"dloc":"'''''string'''''"</code>
|JSON||<code>"DependentLocality":"'''''string'''''"</code>
|-
|-
|REST||<code>&dloc = '''''string'''''</code>
|REST||<code>&dloc = '''''string'''''</code>
Line 406: Line 407:
!Protocol !! Syntax
!Protocol !! Syntax
|-
|-
|JSON||<code>"ddloc":"'''''string'''''"</code>
|JSON||<code>"DoubleDependentLocality":"'''''string'''''"</code>
|-
|-
|REST||<code>&ddloc = '''''string'''''</code>
|REST||<code>&ddloc = '''''string'''''</code>
Line 412: Line 413:




<h3 style="background-color:rgb(240,240,240);">Administrative Area</h3>
<h3 style="background-color:rgb(240,240,240);">Sub Administrative Area</h3>
:''Optional.''
:''Optional.''


:The most common geographic data element.
:The smallest geographic data element.


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




<h3 style="background-color:rgb(240,240,240);">Sub Administrative Area</h3>
<h3 style="background-color:rgb(240,240,240);">Administrative Area</h3>
:''Optional.''
:''Optional.''


:The smallest geographic data element.
:The most common geographic data element.


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




<h3 style="background-color:rgb(240,240,240);">Postal Code</h3>
<h3 style="background-color:rgb(240,240,240);">Sub National Area</h3>
:''Optional.''
:''Optional.''


:The complete postal code for a particular delivery point.
:The administrative region within a country on an arbitrary level below that of the sovereign state.


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




<h3 style="background-color:rgb(240,240,240);">Sub National Area</h3>
<h3 style="background-color:rgb(240,240,240);">Postal Code</h3>
:''Optional.''
:''Optional.''


:The administrative region within a country on an arbitrary level below that of the sovereign state.
:The complete postal code for a particular delivery point.


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


Line 476: Line 477:
!Protocol !! Syntax
!Protocol !! Syntax
|-
|-
|JSON||<code>"ctry":"'''''string'''''"</code>
|JSON||<code>"Country":"'''''string'''''"</code>
|-
|-
|REST||<code>&ctry = '''''string'''''</code>
|REST||<code>&ctry = '''''string'''''</code>
Line 490: Line 491:
!Protocol !! Syntax
!Protocol !! Syntax
|-
|-
|JSON||<code>"mak":"'''''string'''''"</code>
|JSON||<code>"MelissaAddressKey":"'''''string'''''"</code>
|-
|-
|REST||<code>&mak = '''''string'''''</code>
|REST||<code>&mak = '''''string'''''</code>

Latest revision as of 16:25, 7 December 2018

← 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 request consists of a protocol to make a call to the service, detailing desired elements. Your License Key is required.

Business Coder UK supports the JSON and REST protocols to access the service.


URL

Use URL
Standard http://globalbusinesscoder.melissadata.net/WEB/BusinessCoder/doBusinessCoderGB
Secure https://globalbusinesscoder.melissadata.net/WEB/BusinessCoder/doBusinessCoderGB


Field Names

This is a list of the request field names and their protocol naming conventions.

Field Name Level REST JSON
Transmission Reference Request t TransmissionReference
License Key id CustomerID
Column cols Columns
Options opt Options
Format format Format
Record ID Record rec RecordID
Company Name comp Company
Address Line 1 a1 AddressLine1
Address Line 2 a2 AddressLine2
Address Line 3 a3 AddressLine3
Address Line 4 a4 AddressLine4
Locality loc Locality
Dependent Locality dloc DependentLocality
Double Dependent Locality ddloc DoubleDependentLocality
Sub Administrative Area sarea SubAdministrativeArea
Administrative Area area AdministrativeArea
Sub National Area subnat SubNationalArea
Postal Code postal PostalCode
Country ctry Country
Melissa Address Key (MAK) mak MelissaAddressKey


Minimum Inputs

The following are the possible minimum input requirements.

  1. Address and Company
  2. Address Only


Request Elements

The following elements set the basic options for each request. These apply to the entire request, not the individual records.

Transmission Reference

Optional.
This is a string value that serves as a unique identifier for this set of records. It is returned as sent.
Protocol Syntax
JSON "TransmissionReference":"string"
REST ?t = string


License Key

Required.
This is a string value containing the License Key issued to the customer by Melissa for Business Coder UK.
If this element is absent, the Web Service will return an error. To receive a License Key, please contact your Melissa sales representative at 1-800-MELISSA.
Protocol Syntax
JSON "CustomerID":"string"
REST &id = string


Column

Optional.
This string value specifies which column(s) to be output as a comma delimited string.
Protocol Syntax
JSON "Columns":"string"
REST &cols = string


Entering the column name will return the column. Specifying a group name will return all columns in the group.
List multiple columns in the following format, with multiple options delimited with a ",".
Syntax
ColumnName,ColumnName,ColumnName


Field Name Group
AddressLine1 [Default]

These columns are returned by default.

AddressLine2
AddressLine3
AddressLine4
AdministrativeArea
CompanyName
CountryName
FormattedAddress
Locality
MelissaAddressKey
MelissaAddressKeyBase
PostalCode
RecordID
Results
AddressType GrpAddressDetails
Building
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


Options

Optional.
This is a string value containing the options set by the user.
Protocol Syntax
JSON "Options":"string"
REST &opt = string


List options in the following format.
Syntax
OptionName:Parameter


Format

Optional.
The desired format of the response.
Protocol Syntax
JSON "Format":"string"
REST &format = string


Request Record Elements

REST will only contain the Records element.

Protocol Definition
JSON Each record will be contained within [{}] under the Records element.
REST The REST interface only allows a single record per request.


Record ID

Optional.
This is a string value containing a unique identifier for the current record. Use this to match the record submitted with the record returned. It will return what is inputted.
Protocol Syntax
JSON "RecordID":"string"
REST &rec = string


Company Name

Optional.
The name of the business.
Protocol Syntax
JSON "Company":"string"
REST &comp = string


Address Line 1

Optional.
The first address line of the business.
Protocol Syntax
JSON "AddressLine1":"string"
REST &a1 = string


Address Line 2

Optional.
The second address line of the business.
Protocol Syntax
JSON "AddressLine2":"string"
REST &a2 = string


Address Line 3

Optional.
The third address line of the business.
Protocol Syntax
JSON "AddressLine3":"string"
REST &a3 = string


Address Line 4

Optional.
The fourth address line of the business.
Protocol Syntax
JSON "AddressLine4":"string"
REST &a4 = string


Locality

Optional.
The most common population center data element.
Protocol Syntax
JSON "Locality":"string"
REST &loc = string


Dependent Locality

Optional.
The smaller population center data element. This depends on the Locality element.
Protocol Syntax
JSON "DependentLocality":"string"
REST &dloc = string


Double Dependent Locality

Optional.
The smallest population center data element. This depends on the Locality and DependentLocality elements.
Protocol Syntax
JSON "DoubleDependentLocality":"string"
REST &ddloc = string


Sub Administrative Area

Optional.
The smallest geographic data element.
Protocol Syntax
JSON "SubAdministrativeArea":"string"
REST &sarea = string


Administrative Area

Optional.
The most common geographic data element.
Protocol Syntax
JSON "AdministrativeArea":"string"
REST &area = string


Sub National Area

Optional.
The administrative region within a country on an arbitrary level below that of the sovereign state.
Protocol Syntax
JSON "SubNationalArea":"string"
REST &subnat = string


Postal Code

Optional.
The complete postal code for a particular delivery point.
Protocol Syntax
JSON "PostalCode":"string"
REST &postal = string


Country

Optional.
The country name, abbreviation, or code.
Protocol Syntax
JSON "Country":"string"
REST &ctry = string


Melissa Address Key (MAK)

Optional.
A propietary unique key identifier for an address. This is derived from Address Checking.
Protocol Syntax
JSON "MelissaAddressKey":"string"
REST &mak = string
Retrieved from "http://wiki.melissadata.com/index.php?title=Business_Coder_UK:Request&oldid=15628"