ATI_ValidateInternational()

ATI_ValidateInternational() can be used to validate a non-US address when provided with the following data:

  • Street address information

To achieve this, first generate a unique ID with ATI_GetUniqueID(), then populate and write a record to ATIINTREQ that contains the address data to be validated. Then, call ATI_ValidateInternational() by passing in your unique ID and other parameters as shown.

ATI_ValidateInternational() will return *On if no error occurred, or *Off if there an error was encountered. If an error occurred, you can review the subfields in the ErrorDS parameter data structure to retrieve information about the error. Errors are also logged in the file ATIERRLOG.

Subprocedure Prototype

Dcl-Pr ATI_ValidateInternational Ind ExtProc(*DclCase);

Returns *OFF if an error occurs during processing, *ON otherwise.

 
  pUniqueId Like(ATI_UniqueID_t) Const;

Unique ID generated with ATI_GetUniqueID()

 
  pConfigID Like(ATI_ConfigID_t) Const;

Config ID of config record to load

 
  pErrorDS LikeDS(ATI_ErrorDS_t) Options(*Omit:*NoPass);

Error data structure used to capture errors

 
End-Pr;
 

Data Structures

Dcl-Ds ATI_ErrorDS_t Qualified Template Inz;
  
  MessageCode VarChar(10);

Message code of error message

 
  Message VarChar(1024);

Error message text

 
  Source VarChar(10);

Error message source

 
  Subprocedure VarChar(132);

Subprocedure which received error

 
  LogFile Like(ATI_FilePath_t);

IFS filepath of generated log file

 
End-Ds;
 

Input Table Files

Field Name Long Field Name Data Type Field Title Comments 
UID
 
ADDRESSID
 
DECIMAL(24:0)
 Address Record Unique ID 
COUNTRY
 
COUNTRY
 
VARCHAR(64)
 Country Name 
GEOCODE
 
GEOCODE
 
CHAR(1)
 Enable Geocoding 
ADDRESSEE
 
ADDRESSEE
 
VARCHAR(256)
 Name of the recipient, firm, or company 
ADDRESS1
 
ADDRESS1
 
VARCHAR(64)
 First Address Line 
ADDRESS2
 
ADDRESS2
 
VARCHAR(64)
 Second Address Line 
ADDRESS3
 
ADDRESS3
 
VARCHAR(64)
 Third Address Line 
ADDRESS4
 
ADDRESS4
 
VARCHAR(64)
 Fourth Address Line 
CITY
 
CITY
 
VARCHAR(64)
 City Name 
ADMINAREA
 
ADMINISTRATIVEAREA
 
VARCHAR(32)
 State or Providence Name Abbreviation 
POSTALCODE
 
POSTALCODE
 
VARCHAR(16)
 Postal Code 
REQTS
 
REQUESTTIMESTAMP
 
TIMESTAMP
 Request Timestamp

Output Table Files

Field Name Long Field Name Data Type Field Title Comments 
UID
 
ADDRESSID
 
DECIMAL(24:0)
 Address Record Unique ID 
INPUTINDEX
 
INPUTINDEX
 
DECIMAL(24:0)
 Address Input Index 
CANDINDEX
 
CANDIDATEINDEX
 
DECIMAL(24:0)
 Address Candidate Index 
CRDUSED
 
CREDITSUSED
 
DECIMAL(2:0)
 Credits Used 
CURBLKRM
 
CURRENTBLOCKREMAINING
 
DECIMAL(9:0)
 Current Block Remaining 
ALLBLKRM
 
ALLBLOCKSREMAINING
 
DECIMAL(12:0)
 All Blocks Remaining 
ADDRESSEE
 
ADDRESSEE
 
VARCHAR(256)
 Addressee 
ADDRESS1
 
ADDRESS1
 
VARCHAR(256)
 Formatted address line 1 
ADDRESS2
 
ADDRESS2
 
VARCHAR(256)
 Formatted address line 2 
ADDRESS3
 
ADDRESS3
 
VARCHAR(256)
 Formatted address line 3 
ADDRESS4
 
ADDRESS4
 
VARCHAR(256)
 Formatted address line 4 
ADDRESS5
 
ADDRESS5
 
VARCHAR(256)
 Formatted address line 5 
ADDRESS6
 
ADDRESS6
 
VARCHAR(256)
 Formatted address line 6 
ADDRESS7
 
ADDRESS7
 
VARCHAR(256)
 Formatted address line 7 
ADDRESS8
 
ADDRESS8
 
VARCHAR(256)
 Formatted address line 8 
ADDRESS9
 
ADDRESS9
 
VARCHAR(256)
 Formatted address line 9 
ADDRESS10
 
ADDRESS10
 
VARCHAR(256)
 Formatted address line 10 
ADDRESS11
 
ADDRESS11
 
VARCHAR(256)
 Formatted address line 11 
ADDRESS12
 
ADDRESS12
 
VARCHAR(256)
 Formatted address line 12 
ISO3
 
COUNTRYISO3
 
VARCHAR(3)
 ISO 3166-1 alpha-3 country code 
ADAREA
 
ADMINISTRATIVEAREA
 
VARCHAR(64)
 Most common administrative division 
SUPADAREA
 
SUPERADMINISTRATIVEAREA
 
VARCHAR(64)
 Largest administrative division 
SUBADAREA
 
SUBADMINISTRATIVEAREA
 
VARCHAR(64)
 Smallest administrative division 
CITY
 
CITY
 
VARCHAR(64)
 City name 
DEPCITY
 
DEPENDENTCITY
 
VARCHAR(64)
 Additional information about the city 
DEPCITYNM
 
DEPENDENTCITYNAME
 
VARCHAR(64)
 Name of dependant city 
DBDEPCITY
 
DOUBLEDEPENDENTCITY
 
VARCHAR(64)
 Double dependent city 
ZIPCODE
 
POSTALCODE
 
VARCHAR(64)
 Complete postal code 
ZIPCODESH
 
POSTALCODESHORT
 
VARCHAR(64)
 Postal code short 
ZIPCODEEX
 
POSTALCODEEXTRA
 
VARCHAR(64)
 Postal code extra 
PREMISE
 
PREMISE
 
VARCHAR(64)
 Alphanumeric location code 
PREMEXT
 
PREMISEEXTRA
 
VARCHAR(64)
 Premise extra 
PREMNBR
 
PREMISENUMBER
 
VARCHAR(64)
 Premise number 
PREMTYPE
 
PREMISETYPE
 
VARCHAR(64)
 Premise type 
THOFARE
 
THOROUGHFARE
 
VARCHAR(64)
 Thoroughfare 
THOFAREPRE
 
THOROUGHFAREPREDIRECTION
 
VARCHAR(64)
 Thoroughfare predirection 
THOFAREPST
 
THOROUGHFAREPOSTDIRECTION
 
VARCHAR(64)
 Thoroughfare postdirection 
THOFARENME
 
THOROUGHFARENAME
 
VARCHAR(64)
 Thoroughfare name 
THOFARETRL
 
THOROUGHFARETRAILINGTYPE
 
VARCHAR(64)
 Thoroughfare trailing type 
THOFARETYP
 
THOROUGHFARETYPE
 
VARCHAR(64)
 Thoroughfare type 
DEPFARE
 
DEPENDENTTHOROUGHFARE
 
VARCHAR(64)
 Dependent thoroughfare 
DEPFAREPRE
 
DEPENDENTTHOROUGHFAREPREDIRECTION
 
VARCHAR(64)
 Dependent thoroughfare predirection 
DEPFAREPST
 
DEPENDENTTHOROUGHFAREPOSTDIRECTION
 
VARCHAR(64)
 Dependent thoroughfare postdirection 
DEPFARENME
 
DEPENDENTTHOROUGHFARENAME
 
VARCHAR(64)
 Dependent thoroughfare name 
DEPFARETRL
 
DEPENDENTTHOROUGHFARETRAILINGTYPE
 
VARCHAR(64)
 Dependent thoroughfare trailing type 
DEPFARETYP
 
DEPENDENTTHOROUGHFARETYPE
 
VARCHAR(64)
 Dependent thoroughfare type 
BUILDING
 
BUILDING
 
VARCHAR(64)
 Building 
BUILDTYP
 
BUILDINGLEADINGTYPE
 
VARCHAR(64)
 Building leading type 
BUILDNME
 
BUILDINGNAME
 
VARCHAR(64)
 Building name 
BUILDTRL
 
BUILDINGTRAILINGTYPE
 
VARCHAR(64)
 Building trailing type 
SBUILD
 
SUBBUILDING
 
VARCHAR(64)
 Sub-building 
SBUILDTYP
 
SUBBUILDINGTYPE
 
VARCHAR(64)
 Sub-building type 
SBUILDNMB
 
SUBBUILDINGNUMBER
 
VARCHAR(64)
 Sub-building number 
SBUILDNME
 
SUBBUILDINGNAME
 
VARCHAR(64)
 Sub-building name 
POBOX
 
POSTBOX
 
VARCHAR(64)
 Post box 
POBOXTYP
 
POSTBOXTYPE
 
VARCHAR(64)
 Post box type 
POBOXNBR
 
POSTBOXNUMBER
 
VARCHAR(64)
 Post box number 
LATITUDE
 
LATITUDE
 
DECIMAL(9:6)
 Latitude 
LONGITUDE
 
LONGITUDE
 
DECIMAL(9:6)
 Longitude 
GEOCODE
 
GEOCODEPRECISION
 
VARCHAR(18)
 Indicates precision level latitude/longitude 
MAXGEOCODE
 
MAXGEOCODEPRECISION
 
VARCHAR(16)
 Best geocode precision available. 
ADRFORMAT
 
ADDRESSFORMAT
 
VARCHAR(256)
 Address format 
VERSTATUS
 
VERIFICATIONSTATUS
 
VARCHAR(16)
 Verification status 
ADRPREC
 
ADDRESSPRECISION
 
VARCHAR(24)
 Address precision 
MAXADRPREC
 
MAXADDRESSPRECISION
 
VARCHAR(16)
 Max address precision 
CADDRESSEE
 
CHANGESADDRESSEE
 
VARCHAR(64)
 Changes to addressee 
CADDRESS1
 
CHANGESADDRESS1
 
VARCHAR(64)
 Changes to address 1 
CADDRESS2
 
CHANGESADDRESS2
 
VARCHAR(64)
 Changes to address 2 
CADDRESS3
 
CHANGESADDRESS3
 
VARCHAR(64)
 Changes to address 3 
CADDRESS4
 
CHANGESADDRESS4
 
VARCHAR(64)
 Changes to address 4 
CADDRESS5
 
CHANGESADDRESS5
 
VARCHAR(64)
 Changes to address 5 
CADDRESS6
 
CHANGESADDRESS6
 
VARCHAR(64)
 Changes to address 6 
CADDRESS7
 
CHANGESADDRESS7
 
VARCHAR(64)
 Changes to address 7 
CADDRESS8
 
CHANGESADDRESS8
 
VARCHAR(64)
 Changes to address 8 
CADDRESS9
 
CHANGESADDRESS9
 
VARCHAR(64)
 Changes to address 9 
CADDRESS10
 
CHANGESADDRESS10
 
VARCHAR(64)
 Changes to address 10 
CADDRESS11
 
CHANGESADDRESS11
 
VARCHAR(64)
 Changes to address 11 
CADDRESS12
 
CHANGESADDRESS12
 
VARCHAR(64)
 Changes to address 12 
CISO3
 
CHANGESCOUNTRYISO3
 
VARCHAR(3)
 Changes to ISO 
CADAREA
 
CHANGESADMINISTRATIVEAREA
 
VARCHAR(64)
 Changes to administrative area 
CSUPADAREA
 
CHANGESSUPERADMINISTRATIVEAREA
 
VARCHAR(64)
 Changes to super administrative area 
CSUBADAREA
 
CHANGESSUBADMINISTRATIVEAREA
 
VARCHAR(64)
 Changes to sub-administrative area 
CCITY
 
CHANGESCITY
 
VARCHAR(64)
 Changes to city 
CDEPCITY
 
CHANGESDEPENDENTCITY
 
VARCHAR(64)
 Changes to dependent city 
CDEPCITYNM
 
CHANGESDEPENDENTCITYNAME
 
VARCHAR(64)
 Changes to dependent city name 
CDBDEPCITY
 
CHANGESDOUBLEDEPENDENTCITY
 
VARCHAR(64)
 Changes to double dependent city 
CZIPCODE
 
CHANGESPOSTALCODE
 
VARCHAR(64)
 Changes to zipcode 
CZIPCODESH
 
CHANGESPOSTALCODESHORT
 
VARCHAR(64)
 Changes to zipcode short 
CZIPCODEEX
 
CHANGESPOSTALCODEEXTRA
 
VARCHAR(64)
 Changes to zipcode extra 
CPREMISE
 
CHANGESPREMISE
 
VARCHAR(64)
 Changes to premise 
CPREMEXT
 
CHANGESPREMISEEXTRA
 
VARCHAR(64)
 Changes to premise extra 
CPREMNBR
 
CHANGESPREMISENUMBER
 
VARCHAR(64)
 Changes to premise number 
CPREMTYPE
 
CHANGESPREMISETYPE
 
VARCHAR(64)
 Changes to premise type 
CTHOFARE
 
CHANGESTHOROUGHFARE
 
VARCHAR(64)
 Changes to thoroughfare 
CTHOFARPRE
 
CHANGESTHOROUGHFAREPREDIRECTION
 
VARCHAR(64)
 Changes to thoroughfare predirection 
CTHOFARPST
 
CHANGESTHOROUGHFAREPOSTDIRECTION
 
VARCHAR(64)
 Changes to thoroughfare postdirection 
CTHOFARNME
 
CHANGESTHOROUGHFARENAME
 
VARCHAR(64)
 Changes to thoroughfare name 
CTHOFARTRL
 
CHANGESTHOROUGHFARETRAILINGTYPE
 
VARCHAR(64)
 Changes to thoroughfare trailing type 
CTHOFARTYP
 
CHANGESTHOROUGHFARETYPE
 
VARCHAR(64)
 Changes to thoroughfare type 
CDEPFAR
 
CHANGESDEPENDENTTHOROUGHFARE
 
VARCHAR(64)
 Changes to dependent thoroughfare 
CDEPFARPRE
 
CHANGESDEPENDENTTHOROUGHFAREPREDIRECTION
 
VARCHAR(64)
 Changes to dependent thoroughfare predirection 
CDEPFARPST
 
CHANGESDEPENDENTTHOROUGHFAREPOSTDIRECTION
 
VARCHAR(64)
 Changes to dependent thoroughfare postdirection 
CDEPFARNME
 
CHANGESDEPENDENTTHOROUGHFARENAME
 
VARCHAR(64)
 Changes to dependent thoroughfare name 
CDEPFARTRL
 
CHANGESDEPENDENTTHOROUGHFARETRAILINGTYPE
 
VARCHAR(64)
 Changes to dependent thoroughfare trailing type 
CDEPFARTYP
 
CHANGESDEPENDENTTHOROUGHFARETYPE
 
VARCHAR(64)
 Changes to dependent thoroughfare type 
CBUILDING
 
CHANGESBUILDING
 
VARCHAR(64)
 Changes to building 
CBUILDTYP
 
CHANGESBUILDINGLEADINGTYPE
 
VARCHAR(64)
 Changes to building type 
CBUILDNME
 
CHANGESBUILDINGNAME
 
VARCHAR(64)
 Changes to building name 
CBUILDTRL
 
CHANGESBUILDINGTRAILINGTYPE
 
VARCHAR(64)
 Changes to building trailing type 
CSBUILD
 
CHANGESSUBBUILDING
 
VARCHAR(64)
 Changes to sub-building 
CSBUILDTYP
 
CHANGESSUBBUILDINGTYPE
 
VARCHAR(64)
 Changes to sub-building type 
CSBUILDNMB
 
CHANGESSUBBUILDINGNUMBER
 
VARCHAR(64)
 Changes to sub-building number 
CSBUILDNME
 
CHANGESSUBBUILDINGNAME
 
VARCHAR(64)
 Changes to sub-building name 
CPOBOX
 
CHANGESPOSTBOX
 
VARCHAR(64)
 Changes to post box 
CPOBOXTYP
 
CHANGESPOSTBOXTYPE
 
VARCHAR(64)
 Changes to post box type 
CPOBOXNBR
 
CHANGESPOSTBOXNUMBER
 
VARCHAR(64)
 Changes to post box number
Field Name Long Field Name Data Type Field Title Comments 
PID
 
REQUESTID
 
DECIMAL(24:0)
 Request Unique ID 
UID
 
ERRORID
 
DECIMAL(2:0)
 Error Record Unique ID 
MSGCDE
 
MESSAGECODE
 
VARCHAR(10)
 Error message code 
MESSAGE
 
MESSAGE
 
VARCHAR(1024)
 Error message 
SOURCE
 
SOURCE
 
VARCHAR(10)
 Error source 
SUBPROC
 
SUBPROCEDURE
 
VARCHAR(132)
 Error source subprocedure 
LOGFILE
 
LOGFILE
 
VARCHAR(1024)
 Error logfile 
ERRTS
 
ERRORTIMESTAMP
 
TIMESTAMP
 Error timestamp