This code showcases the Melissa Address Object using C#.
Please feel free to copy or embed this code to your own project. Happy coding!
For the latest Melissa Address Object release notes, please visit: https://releasenotes.melissa.com/on-premise-api/address-object/
For further details, please visit: https://docs.melissa.com/on-premise-api/address-object/address-object-quickstart.html
The console will ask the user for:
- Address
- City
- State
- Zip
And return
- Melissa Address Key (MAK)
- Address Line 1
- Address Line 2
- City
- State
- Zip
- Result Codes
- Windows 10 64-bit .NET 7.0, Powershell 5.1
- Melissa data files for 2024-04
This is the c++ code of the Melissa Object
- Addr.dbf
- Congress.csv
- dph256.dte
- dph256.hsa
- dph256.hsc
- dph256.hsf
- dph256.hsn
- dph256.hsv
- dph256.hsx
- ews.txt
- lcd256
- mdAddr.dat
- mdAddr.lic
- mdAddr.nat
- mdAddr.str
- mdAddrKey.db
- mdAddrKeyCA.db
- mdCanada3.db
- mdCanadaPOC.db
- mdLACS256.dat
- mdRBDI.dat
- mdSteLink256.dat
- mdSuiteFinder.db
- month256.dat
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
Before starting, make sure that the .NET 7.0 SDK has been correctly installed on your machine (If you have Visual Studio installed, you most likely have it already). If you are unsure, you can check by opening a command prompt window and typing the following:
dotnet --list-sdks
If the .NET 7.0 SDK is already installed, you should see it in the following list:
As long as the above list contains version 7.0.xxx
(underlined in red), then you can skip to the next step. If your list does not contain version 7.0, or you get any kind of error message, then you will need to download and install the .NET 7.0 SDK from the Microsoft website.
To download, follow this link: https://dotnet.microsoft.com/en-us/download/dotnet
Select .NET 7.0
and you will be navigated to the download page.
Click and download the x64
SDK installer for your operating system.
(IMPORTANT: Make sure you download the SDK, NOT the runtime. the SDK contains both the runtime as well as the tools needed to build the project.)
Once clicked, your web browser will begin downloading an installer for the SDK. Run the installer and follow all of the prompts to complete the installation (your computer may ask you to restart before you can continue). Once all of that is done, you should be able to verify that the SDK is installed with the dotnet --list-sdks
command.
If running Powershell for the first time, you will need to run this command in the Powershell console: Set-ExecutionPolicy RemoteSigned
.
The console will then prompt you with the following warning shown in the image below.
- Enter
'A'
.- If successful, the console will not output any messages. (You may need to run Powershell as administrator to enforce this setting).
$ git clone https://github.com/MelissaData/AddressObject-Dotnet
$ cd AddressObject-Dotnet
Melissa Updater is a CLI application allowing the user to update their Melissa applications/data.
- Download Melissa Updater here: https://releases.melissadata.net/Download/Library/WINDOWS/NET/ANY/latest/MelissaUpdater.exe
- Create a folder within the cloned repo called
MelissaUpdater
. - Put
MelissaUpdater.exe
in theMelissaUpdater
folder you've just created.
- Using Melissa Updater
- It will handle all of the data download/path and dll(s) for you.
- If you already have the latest DQS release zip, you can find the data file(s) in there
- To pass in your own data file path directory, you may either use the '-dataPath' parameter or enter the data file path directly in interactive mode.
- Comment out this line "DownloadDataFiles -license $License" in the powershell script.
- This will prevent you from having to redownload all the files.
Parameters:
-
-address: a test street address (house number & street name)
-
-city (optional): a test city
-
-state (optional): a test state
-
-zip (optional): a test zip code
These are convenient when you want to get results for a specific address in one run instead of testing multiple addresses in interactive mode.
-
-dataPath (optional): a data file path directory to test the Address Object
-
-license (optional): a license string to test the Address Object
-
-quiet (optional): add to command if you do not want to get any console output from the Melissa Updater
When you have modified the script to match your data location, let's run the script. There are two modes:
-
Interactive
The script will prompt the user for an address, city, state, and zip, then use the provided inputs to test Address Object. For example:
$ .\MelissaAddressObjectWindowsDotnet.ps1
For quiet mode:
$ .\MelissaAddressObjectWindowsDotnet.ps1 -quiet
-
Command Line
You can pass an address, city, state, zip, and a license string into the
-address
,-city
,-state
,-zip
, and-license
parameters respectively to test Address Object. For example:With all parameters:
$ .\MelissaAddressObjectWindowsDotnet.ps1 -address "22382 Avenida Empresa" -city "Rancho Santa Margarita" -state "CA" -zip "92688" $ .\MelissaAddressObjectWindowsDotnet.ps1 -address "22382 Avenida Empresa" -city "Rancho Santa Margarita" -state "CA" -zip "92688" -license "<your_license_string>"
With any known (optional) parameters:
$ .\MelissaAddressObjectWindowsDotnet.ps1 -address "22382 Avenida Empresa" -state "CA" $ .\MelissaAddressObjectWindowsDotnet.ps1 -address "22382 Avenida Empresa" -state "CA" -license "<your_license_string>"
For quiet mode:
$ .\MelissaAddressObjectWindowsDotnet.ps1 -address "22382 Avenida Empresa" -city "Rancho Santa Margarita" -state "CA" -zip "92688" -quiet $ .\MelissaAddressObjectWindowsDotnet.ps1 -address "22382 Avenida Empresa" -city "Rancho Santa Margarita" -state "CA" -zip "92688" -license "<your_license_string>" -quiet
This is the expected outcome of a successful setup for interactive mode:
Troubleshooting for errors found while running your program.
Error | Description |
---|---|
ErrorRequiredFileNotFound | Program is missing a required file. Please check your Data folder and refer to the list of required files above. If you are unable to obtain all required files through the Melissa Updater, please contact technical support below. |
ErrorLicenseExpired | Expired license string. Please contact technical support below. |
For free technical support, please call us at 800-MELISSA ext. 4 (800-635-4772 ext. 4) or email us at tech@melissa.com.
To purchase this product, contact the Melissa sales department at 800-MELISSA ext. 3 (800-635-4772 ext. 3).