Admin at 16:25, 7 December 2018

2018-12-07T16:25:49Z

← Older revision		Revision as of 16:25, 7 December 2018
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}}

Admin at 22:49, 27 November 2017

2017-11-27T22:49:37Z

← Older revision		Revision as of 22:49, 27 November 2017
Line 113:		Line 113:


	: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 ",".		:List multiple columns in the following format, with multiple options delimited with a ",".

Admin at 21:55, 20 November 2017

2017-11-20T21:55:45Z

← Older revision		Revision as of 21:55, 20 November 2017
Line 122:		Line 122:
	\|<code>''ColumnName'',''ColumnName'',''ColumnName''</code>		\|<code>''ColumnName'',''ColumnName'',''ColumnName''</code>
	\|}		\|}


	:{\| class="alternate01 sortable"		:{\| class="alternate01 sortable"

Admin at 21:46, 20 November 2017

2017-11-20T21:46:46Z

← Older revision		Revision as of 21:46, 20 November 2017
Line 113:		Line 113:


	Entering the column name to return the column. Specifying a group name will return all columns in the group.		:Entering the column name to 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"

Admin at 19:02, 31 October 2017

2017-10-31T19:02:11Z

Show changes

Admin at 23:10, 13 October 2017

2017-10-13T23:10:10Z

@@ Line 245: / Line 245: @@
 |-
 |<code>''OptionName'':''Parameter''</code>
 |}

Admin at 17:42, 13 October 2017

2017-10-13T17:42:39Z

← Older revision		Revision as of 17:42, 13 October 2017
Line 63:		Line 63:

	#Address and Company		#Address and Company
	~~#MAK and Company~~
	#Address Only		#Address Only
	~~#MAK Only~~

Admin at 17:01, 11 October 2017

2017-10-11T17:01:41Z

← Older revision		Revision as of 17:01, 11 October 2017
Line 163:		Line 163:
	\|DependentThoroughfare		\|DependentThoroughfare
	\|-		\|-
	\|~~DependentThoroughfareLeadinType~~		\|DependentThoroughfareLeadingType
	\|-		\|-
	\|DependentThoroughfareName		\|DependentThoroughfareName
Line 193:		Line 193:
	\|Thoroughfare		\|Thoroughfare
	\|-		\|-
	\|~~ThoroughfareLeadinType~~		\|ThoroughfareLeadingType
	\|-		\|-
	\|ThoroughfareName		\|ThoroughfareName

Admin: Created page with "{{BusinessCoderUKNav |InputOutputCollapse= }} {{CustomTOC}} A request consists of a protocol to make a call to the service, detailing desired elements. Your License Key is ..."

2017-10-10T23:07:00Z

Created page with "{{BusinessCoderUKNav |InputOutputCollapse= }} {{CustomTOC}} A request consists of a protocol to make a call to the service, detailing desired elements. Your License Key is ..."

New page

{{BusinessCoderUKNav
|InputOutputCollapse=
}}

{{CustomTOC}}

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.

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

{| class="alternate01 sortable"
!Field Name !! Level !! REST !! JSON
|-
|Transmission Reference||rowspan="5" valign="center"|Request||t||t
|-
|License Key||id||id
|-
|Column||cols||cols
|-
|Options||opt||opt
|-
|Format||format||format
|-
|Record ID||rowspan="15"|Record||rec||rec
|-
|Company Name||comp||comp
|-
|Address Line 1||a1||a1
|-
|Address Line 2||a2||a2
|-
|Address Line 3||a3||a3
|-
|Address Line 4||a4||a4
|-
|Locality||loc||loc
|-
|Dependent Locality||dloc||dloc
|-
|Double Dependent Locality||ddloc||ddloc
|-
|Administrative Area||area||area
|-
|Sub Administrative Area||sarea||sarea
|-
|Postal Code||postal||postal
|-
|Sub National Area||subnat||subnat
|-
|Country||ctry||ctry
|-
|Melissa Address Key (MAK)||mak||mak
|}

==Minimum Inputs==
The following are the possible minimum input requirements.

#Address and Company
#MAK and Company
#Address Only
#MAK Only

==Request Elements==
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);">Transmission Reference</h3>
:''Optional.''

:This is a string value that serves as a unique identifier for this set of records. It is returned as sent.

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

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

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

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

:This string value specifies which column(s) to be output as a comma delimited string.

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

Entering the column name to return the column. Specifying a group name will return all columns in the group.

:{| class="alternate01 sortable"
!Field Name !! Group
|-
|AddressLine1||rowspan="14"|'''[Default]'''
These columns are returned by default.
|-
|AddressLine2
|-
|AddressLine3
|-
|AddressLine4
|-
|AdministrativeArea
|-
|CompanyName
|-
|CountryName
|-
|FormattedAddress
|-
|Locality
|-
|MelissaAddressKey
|-
|MelissaAddressKeyBase
|-
|PostalCode
|-
|RecordID
|-
|Results
|-
|AddressType||rowspan="27"|'''GrpAddressDetails'''
|-
|Building
|-
|CountryCode
|-
|CountyName
|-
|DeliveryIndicator
|-
|DependentLocality
|-
|DependentThoroughfare
|-
|DependentThoroughfareLeadinType
|-
|DependentThoroughfareName
|-
|DependentThoroughfarePostDirection
|-
|DependentThoroughfarePreDirection
|-
|DependentThoroughfareTrailingType
|-
|DoubleDependentLocality
|-
|PostBox
|-
|PremisesNumber
|-
|PremisesType
|-
|SubAdministrativeArea
|-
|SubNationalArea
|-
|SubPremises
|-
|SubPremisesNumber
|-
|SubPremisesType
|-
|Thoroughfare
|-
|ThoroughfareLeadinType
|-
|ThoroughfareName
|-
|ThoroughfarePostDirection
|-
|ThoroughfarePreDirection
|-
|ThoroughfareTrailingType
|-
|IncorporationDate||rowspan="9"|'''GrpFirmographics'''
|-
|SICCode1
|-
|SICCode2
|-
|SICCode3
|-
|SICCode4
|-
|SICDescription1
|-
|SICDescription2
|-
|SICDescription3
|-
|SICDescription4
|-
|Latitude||rowspan="2"|'''GrpGeoCode'''
|-
|Longitude
|}

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

:This is a string value containing the options set by the user.

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

:List options in the following format.

:{| class="alternate01"
!Syntax
|-
|<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.
|}

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

:The desired format of the response.

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

==Request Record Elements==
REST will only contain the Records element.

{| class="alternate01"
!Protocol !! Definition
|-
|JSON||Each record will be contained within [{}] under the Records element.
|-
|REST||The REST interface only allows a single record per request.
|}

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

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

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

:The name of the business.

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

<h3 style="background-color:rgb(240,240,240);">Address Line 1</h3>
:''Optional.''

:The first address line of the business.

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

<h3 style="background-color:rgb(240,240,240);">Address Line 2</h3>
:''Optional.''

:The second address line of the business.

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

<h3 style="background-color:rgb(240,240,240);">Address Line 3</h3>
:''Optional.''

:The third address line of the business.

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

<h3 style="background-color:rgb(240,240,240);">Address Line 4</h3>
:''Optional.''

:The fourth address line of the business.

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

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

:The most common population center data element.

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

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

:The smaller population center data element. This depends on the Locality element.

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

<h3 style="background-color:rgb(240,240,240);">Double Dependent Locality</h3>
:''Optional.''

:The smallest population center data element. This depends on the Locality and DependentLocality elements.

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

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

:The most common geographic data element.

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

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

:The smallest geographic data element.

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

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

:The complete postal code for a particular delivery point.

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

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

:The administrative region within a country on an arbitrary level below that of the sovereign state.

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

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

:The country name, abbreviation, or code.

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

<h3 style="background-color:rgb(240,240,240);">Melissa Address Key (MAK)</h3>
:''Optional.''

:A propietary unique key identifier for an address. This is derived from Address Checking.

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

[[Category:Business Coder UK]]
[[Category:Reference]]

Business Coder UK:Request - Revision history