| Function | AddressValidation |
| Output Type | - 1 Standard CF Query: qAddressValidation |
| Error Capture Variables | FedexError - 0 = Success - 1 = Failure - 2 = Hard Error (configuration problem) FedexErrorDesc (contains description of error if present) |
| Test Environment Available | Yes |
| Example Usage | INSTALLED AS A CUSTOM TAG <cf_adminpro_fedexxml function="addressValidation" accountnumber="your-fedex-account-number" fedexindentifier="your-fedex-identifier" ShipToStreet="street address" ShipToStreet2="street address line 2 " ShipToCity="city" ShipToState="2 letter state " ShipToZip="" AddressMatches="5" debug="false" > *Note to use as a custom tag you must install the tool in your ColdFusion server CustomTags directory or have it present in the directory you are calling it from. CFMODULE <cfmodule template="adminpro_fedexxml.cfm" function="addressValidation" accountnumber="your-fedex-account-number" fedexindentifier="your-fedex-identifier" ShipToStreet="street address" ShipToStreet2="street address line 2 " ShipToCity="city" ShipToState="2 letter state " ShipToZip="" AddressMatches="5" debug="false" > |
| Supplied Example Files | av.cfm |
| Address Validation Request | |||||
| Input Attributes (attributes that can be passed to the custom tag with a valid value) | |||||
| Attribute Name | Required | Preset value/value list | Default Value | Restrictions | Explanation/Notes |
| AccountNumber | Yes | NO VALUE | Your active Fedex account number | Your Fedex account number you use for shipping | |
| FedexIndentifier | Yes | NO VALUE | Your Fedex meter number | Your Fedex meter number, received either from Fedex or by running the RegisterRequest function. | |
| ShipToCompany | No | NO VALUE | 35 chars maximum | ||
| ShipToStreet | Yes | NO VALUE | 35 chars maximum | Street address line 1, pass as much of the street address as possible in order to ensure a validated address will be returned. | |
| ShipToStreet2 | No | NO VALUE | 35 chars maximum | Street address line 2, the second line of an address (if it exists) this could be a unit number (Unit 4B), suite number (STE 77), apartment number (APT 4C) or other. | |
| ShipToCity | Yes | NO VALUE | 35 chars maximum | City part of the address to be validated | |
| ShipToState | Yes | NO VALUE | 2 chars maximum | State of the address to be validated (must be valid 2 character US state) | |
| ShipToZip | No | NO VALUE | 9 chars maximum | Zip code (5 digit part) of address to be validated | |
| ShipToUrbanization | No | NO VALUE | 35 chars maximum | For addresses in Puerto Rico multiple houses may share the same house number. In this case also pass the urbanization. | |
| AddressMatches | No | 1 - 10 | 5 | Valid number from 1 to 10 | |
| Fedex Address Validation Request - Output | |||
| Query "qAddressValidation"(1 or more records with following columns) | |||
| Column/Variable Name | Always Present | Default Value | Explanation/Notes |
| Response Failure Variables (Present if FedexError = 0, 1 or 2) | |||
| FedexError | Yes | [0 (Successful transaction), 1 (Error from Fedex), 2 (Hard Error, error with request that could not be handled by Fedex, check attributes passed are valid)] | |
| FedexErrorDesc | Yes | Description of error received | |
| Success Query named qAddressValidation (Present if FedexError = 0) | |||
| Score | Yes | NO VALUE | Matching score (out of 100% match) |
| Rank | Yes | NO VALUE | Rank for the match returned |
| Company | Yes | NO VALUE | Company Name |
| Street1 | Yes | NO VALUE | Validated street address |
| Street2 | Yes | NO VALUE | Validated street address line 2 |
| City | Yes | NO VALUE | Validated street city |
| State | Yes | NO VALUE | Validated state |
| Zipcode | Yes | NO VALUE | Validated zipcode |
| Residential | Yes | NO VALUE | |
| Urbanization | Yes | NO VALUE | Validated urbanization / Puerto Rico |
| SingleHouseNumber | Yes | NO VALUE | Zone used for rate if zone applies |
| SoftErrorType | Yes | NO VALUE | Soft Error with any warnings or information |
| SoftErrorCode | Yes | NO VALUE | Soft Error code |
| SoftErrorMessage | Yes | NO VALUE | Soft Error description |