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.

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