Business Coder UK:Request

← Business Coder UK

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.

Field Name	Level	REST	JSON
Transmission Reference	Request	t	t
License Key		id	id
Column		cols	cols
Options		opt	opt
Format		format	format
Record ID	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.

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	"t":"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	"id":"string"
REST	&id = string

Column

Optional.

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

Protocol	Syntax
JSON	"cols":"string"
REST	&cols = string

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

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	"opt":"string"
REST	&opt = string

List options in the following format.

Syntax
OptionName:Parameter

ReturnDominantBusiness

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.

Option Name	Parameter	Description
ReturnDominantBusiness	yes	Default. Return the dominant business name when the company information is missing or does not match.
	no	Do not return the dominant business name when the company information is missing or does not match.

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	"rec":"string"
REST	&rec = string

Company Name

Optional.

The name of the business.

Protocol	Syntax
JSON	"comp":"string"
REST	&comp = string

Address Line 1

Optional.

The first address line of the business.

Protocol	Syntax
JSON	"a1":"string"
REST	&a1 = string

Address Line 2

Optional.

The second address line of the business.

Protocol	Syntax
JSON	"a2":"string"
REST	&a2 = string

Address Line 3

Optional.

The third address line of the business.

Protocol	Syntax
JSON	"a3":"string"
REST	&a3 = string

Address Line 4

Optional.

The fourth address line of the business.

Protocol	Syntax
JSON	"a4":"string"
REST	&a4 = string

Locality

Optional.

The most common population center data element.

Protocol	Syntax
JSON	"loc":"string"
REST	&loc = string

Dependent Locality

Optional.

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

Protocol	Syntax
JSON	"dloc":"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	"ddloc":"string"
REST	&ddloc = string

Administrative Area

Optional.

The most common geographic data element.

Protocol	Syntax
JSON	"area":"string"
REST	&area = string

Sub Administrative Area

Optional.

The smallest geographic data element.

Protocol	Syntax
JSON	"sarea":"string"
REST	&sarea = string

Postal Code

Optional.

The complete postal code for a particular delivery point.

Protocol	Syntax
JSON	"postal":"string"
REST	&postal = string

Sub National Area

Optional.

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

Protocol	Syntax
JSON	"subnat":"string"
REST	&subnat = string

Country

Optional.

The country name, abbreviation, or code.

Protocol	Syntax
JSON	"ctry":"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	"mak":"string"
REST	&mak = string