fieldStatus

0: fsNotApplicable

Field is not applicable to return field status.

1: fsVerifiedNoChange

Field has been verified using relevant reference data, no changes were needed.

2: fsVerifiedAliasChange

Field has been verified using relevant reference data, an alias change was made during parsing (see fsIdentifiedAlias).

3: fsVerifiedSmallChange

Field has been verified using relevant reference data, a small spelling change was made.

4: fsVerifiedLargeChange

Field has been verified using relevant reference data, a large spelling change was made.

5: fsAdded

Field has been added using relevant reference data.

6: fsIdentifiedNoChange

Field has been identified using relevant lexicon data, no changes were needed. e.g.  an input value of ‘PO Box 1234′ may be identifiable as a PostBox, but if it is unable to be verified then a status of fsIdentifiedNoChange will be returned.

7: fsIdentifiedAlias

Field has been identified using relevant lexicon data, an alias change was made. e.g. an input value of ‘Avnue’ may be identifiable as an alias to the ThoroughfareType ‘Ave’.

8: fsIdentifiedContext

Field has been identified using relevant context rules. e.g. an input Address of ‘123 sdovnsdv San Bruno CA USA’ may identify the word ‘sdovnsdv’ as a Thoroughfare, but only because of the context in which it appears (after an identifiable PremiseNumber, and before an identifiable Locality).

9: fsEmpty

Field is empty.

10: fsUnrecognized

Field was unrecognized.

Field statuses propagate up the field hierarchy, combining under the following rules:

Key

• VNC = fsVerifiedNoChange
• VAC = fsVerifiedAliasChange
• VSC = fsVerifiedSmallChange
• VLC = fsVerifiedLargeChange
• ADD = fsAdded
• INC = fsIdentifiedNoChange
• IAL = fsIdentifiedAliasChange
• ICO = fsIdentifiedContext
• EMP = fsEmpty

processStatus

0: psOK

The command completed normally. The accuracy score must be examined to determine result accuracy.

1: psException

An exception occurred during processing, normally as a result of malformed input data.

2: psServerUninitialized

The command could not be completed as the server has not yet been initialized.

3: psInvalidInputRecord

The input record contains invalid data, often due to the supply of non-UTF8/Unicode data.

serverStatus

0: ssOK

The library has been successfully initialized and ready to accept requests.

1: ssUninitialized

The library has not yet been successfully initialized.

2: ssInvalidDataDirectory

The supplied data directory does not contain a Global Knowledge Repository.

3: ssInvalidUnicodeFileVersion

The installed unicode.lfs file is mismatched with the installed software.

4: ssInvalidCountryFileVersion

The installed country.lfs file is mismatched with the installed software.

5: ssInvalidContextFileVersion

The installed context.lfs file is mismatched with the installed software.

6: ssInvalidFormatFileVersion

The installed format.lfs file is mismatched with the installed software.

7: ssInvalidLexiconFileVersion

The installed lexicon file attempting to be opened is mismatched with the installed software.

8: ssInvalidReferenceFileVersion

The installed lexicon file attempting to be opened is mismatched with the installed software.

9: ssException

An exception was thrown.