This section describes the following return codes: PafFlag, PafDesc, ErrorCode, AddrScore, UpdateFlag.
The PafFlag and PafDesc fields indicate whether a record has been verified or not during the addressing process:
|
PafFlag |
PafDesc |
Description |
|
1 |
Verified |
The record achieved a premise level match from the addressing engine and reached the address level score threshold. This is a confident match. The address and postcode fields will be updated. |
|
2 |
Good |
The record achieve a postcode level match and all input address elements were matched so the result was upgraded to an address level match. The address and postcode fields will be updated. |
|
3 |
Partial |
The record achieved a postcode level match and reached the postcode level score threshold. The postcode field will be updated. |
|
4 |
Tentative |
No Premise information (Org, Sub-building, Building Number, Building Name) was returned, or the score threshold was not met. The address and postcode fields will not be updated. |
|
5 |
NoMatch |
No match was found. |
|
6 |
Foreign |
The record was identified as foreign. |
|
9 |
ProcessingFailure |
An error has occurred processing the record. |
The ErrorCode field is a 17 character field that indicates the verification status. For example, “PREMP===CVVVARRRF”. This consists of nine parts in the following format:
|
ErrorCode part |
Width |
Description |
|
Match level |
4 |
Match level can have the following values: “PREM” – Match to a single premise; “PCOD” – Match to a complete postcode; “PART” – Match to a partial postcode; “NOMA” – No satisfactory match could be found; “FORN” – Foreign address detected. |
|
Passing level |
1 |
Passing level can have the following values: “A” – Address level; “P” – Postcode level; “N” – No match. |
|
Postcode update |
4 |
Postcode update can have the following values: “ ” (four spaces) – No postcode or no match; “----” – Input postcode, no output postcode; “++++” – Output postcode, no input postcode; “====” – No change to postcode; “===C” – Change at postcode level; “==CC” – Change at sector level; “=CCC” – Change at outward code level; “CCCC” – Change at area code level. |
|
Premise flag |
1 |
Premise flag can have the following values: “X” – Not matched; “V” – Verified; “R” – Retained; “C” – Corrected; “A” - Added. |
|
Street flag |
1 |
See premise flag. |
|
Locality flag |
1 |
See premise flag. |
|
Postcode flag |
1 |
See premise flag. |
|
Vanity flags |
3 |
Leading flag can have the following values: “XXX” – Not matched; “SSS” – Some vanity elements retained; “RRR” – Vanity elements retained; “DDD” – Vanity elements removed. |
|
Reformat flag |
1 |
Reformat flag can have the following values: “X” – Not matched; “O” – Original address kept as-is; “F” – Address fully reformatted. |
Values for AddrScore are between 0 and 110 – this is essentially a percentage score boosted by 10 if there are no unmatched words in the input.
The UpdateFlag field indicates whether the record was updated:
|
UpdateFlag |
Description |
|
Address |
Record address and postcode were updated. |
|
Postcode |
Record postcode was updated. |
|
None |
Record not updated. |