Support DESK

Follow

API Input Fields and their Properties

 

Properties

Type

Description

Example

Requirement

Addressee.Contact

string

Standardised form of personal name in one field, as used in addressing mail.

The matchIT API generates this field from input Prefix, FirstNames/Initials and LastName or Addressee It is a Read Only property.

Mr Geoff Smith

Mr G. Smith

Not Required

Addressee.FullName

string

Freeform personal name in one field, as used in addressing mail.

The matchIT API can generate this field from input Prefix, FirstNames/Initials and LastName.

MR G.C. SMITH

Geoff Smith Esq.

Mr G. Smith & Miss S. Brown

Required for matching at Contact, Individual or Family level, if separate Prefix, FirstNames/Initials and LastName fields are not present.

Addressee.Salutation

string

Standardised form of personal name in one field, as a salutation for a letter.

The matchIT API generates this field from input Prefix, FirstNames/Initials and LastName or Addressee It is a Read Only property.

Dear Mr Smith

Not Required

Addressee.NameElements.LastName

string

The last name, typically when the name is split into component parts of Prefix, FirstNames/Initials and LastName.

Smith

van der Valk

Required for matching at Contact, Individual or Family level, if a FullName field is not present.

Addressee.NameElements.FirstNames

string

First names (also called FirstNames) or initials in one field, typically when the name is split into component parts of Prefix, FirstNames/Initials and LastName.

The matchIT API  will generate FirstNames from information contained in a FullName field if present.

J

JR

J R

John Robert,

John R

Required for matching at Contact, Individual or Family level, if a FullName field is not present.

Addressee.NameElements.Initials

string

Initials of either just the middle name(s), or of all the first names.

Where the name of the person is “John R Smith”:

JR or J R if FirstNames is not present or empty.

R if FirstNames contains John

Required for matching at Contact, Individual or Family level, if a FullName field is not present.

Addressee.NameElements.Prefix

string

Personal title

Mr

Mrs

Dr

Professor

Required for matching at Contact, Individual or Family level, if a FullName field is not present.

Addressee.NameElements.Suffix

string

A title in a separate field following the last name.

The matchIT API will generate Suffix from information contained in an Addressee or LastName field if present.

Esq

Jr

Not Required

Addressee.NameElements.Qualification

string

A Qualification.

The matchIT API will generate the Qualification from information contained in an Addressee or LastName field if present.

B.Sc.

ARCS

BCom

Not Required

Addressee.SecondNameElements.LastName

string

The last name of a second individual.

The matchIT API can generate this from information contained in an Addressee field, if the Addressee field is identified as containing more than one name. E.g. “Mr John M Smith and Ms Sarah D Jones”, or “Mr and Mrs Jones”.

Jones

Not Required

Addressee.SecondNameElements.FirstNames

string

The forename(s) of a second individual.

The matchIT API can generate this from information contained in an Addressee field, if the Addressee field is identified as containing more than one name. E.g. “Mr John M Smith and Ms Sarah D Jones”, or “Mr and Mrs Jones”.

Sarah D

Sarah

S D

S

Not Required

Addressee.SecondNameElements.Initials

string

The initials of a second individual.

The matchIT API can generate this from information contained in an Addressee field, if the Addressee field is identified as containing more than one name. E.g. “Mr John M Smith and Ms Sarah D Jones”, or “Mr and Mrs Jones”.

Where the name of the person is “Mrs Sarah D Jones”:

S D if FirstNames is not present or empty.

D if FirstNames contains Sarah

Not Required

Addressee.SecondNameElements.Prefix

string

The prefix of a second individual.

The matchIT API can generate this from information contained in an Addressee field, if the Addressee field is identified as containing more than one name. E.g. “Mr John M Smith and Ms Sarah D Jones”, or “Mr and Mrs Jones”.

Ms

Mrs

Not Required

Address.Lines.Line1

Address.Lines.Line2

Address.Lines.Line3

Address.Lines.Line4

Address.Lines.Line5

Address.Lines.Line6

Address.Lines.Line7

Address.Lines.Line8

Address.Lines.Line9

string

The only line of address, or one of multiple address lines. The address line(s) may also contain postcodes or zip codes, as the matchIT API  can extract these into a designated Postcode field.

560 So Winchester Blvd, Fl 5 San Jose, CA 95128

560 So Winchester Blvd Fl 5 San Jose CA 95128

9 North Street Leatherhead  Surrey  KT22 8DY

Leatherhead KT22 8DY

You must have at least one address line for address matching.

Address.Elements.Postcode

string

Should contain either full or partial UK postcodes or zip codes.

The matchIT API can extract valid postcodes or zip codes from address lines into the Postcode field.

GU14 7BQ

KT228DY

KT22

95128

95128-2519

Required in order to include postcodes and zip codes in the matching process.

Address.Elements.Premise

string

The premise number part of the address – this is the building number, not the apartment or unit number if there is one

The matchIT API can move or copy some premise numbers from an address line to the Premise field.  

260

12-14

Not required, however this can be used within the match keys in order to enhance the accuracy and efficiency when performing matching processes within large files or files containing very localised data.

Address.Elements.FlatNo

string

The apartment or unit number, as opposed to Premise, which is the building number.

The matchIT API can extract or copy apartment or flat numbers from the address lines into the FlatNo field.

A

3

3a

Not Required

Address.Elements.Thoroughfare

string

The thoroughfare element of the address..

The matchIT API can extract or copy what it recognises as the thoroughfare, from the

address lines into the Thoroughfare field.

North Street

The Crescent

Not Required

Address.Elements.Town

string

The town element of the address.

The matchIT API can extract or copy any valid UK post towns, from the address lines into the Town field

Kingston Upon Thames

FARNHAM

Not Required

Address.Elements.Region

string

The US or Australian state or Canadian province, or UK county element of the address.

The matchIT API can extract or copy states or provinces or UK counties, defined as such in the NAMES.DAT file, from the address lines into the Region field.

California

NY

Surrey

Not Required

Address.Elements.Country

string

The country element of the address.

The matchIT API can extract or copy any valid country names from the address lines into the Country field.

England

UK

Azerbaijan

Not Required

Email.Address

string

An email address.

Support@helpIT.com

Sales@helpIT.com

JohnD@helpIT.com

Not Required

Email.Username

string

Contains the username extracted from the email address if its format is correct.

Support

Sales

JohnD

Not Required

Email.Domain

string

Contains the domain extracted from the emailaddress if its format is correct.

helpIT.com

Not Required

Organization.Name

string

A company or business name.

The matchIT API can move some company names from the Addressee or an address line to the Company field.

helpIT systems ltd

The ABC Company

Not Required

Organization.Department

string

A department name.

Sales Dept.

Marketing

Not Required

Organization.Jobtitle

string

A job title.

The matchIT API can move some job titles or department names from the Addressee or an address line to the JobTitle field.

Managing Director

MD

Not Required

Telephone.Number

string

A telephone number.

The matchIT API can split telephone numbers into two parts: TelAreaCode for the area code and TelLocalNumber for the local part of the number. The user can sometimes more effectively use TelLocalNumber for matching.

01372 360070

(01372)  360 070

01372-360070

Not Required

Telephone.Fax

string

A fax number. The matchIT API can split fax numbers into two parts: FaxAreaCode for the area code and FaxLocalNumber for the local part of the number.

As for Telephone.Number

Not Required

 

 

Was this article helpful?
0 out of 0 found this helpful

0 Comments

Please sign in to leave a comment.