Reference Guide

Data Download

Data Download is a web service that validates and routes user requests to download Melissa Data deliverables. This provides you with a way to automate data file downloads, object binaries and other collateral files. File versioning is provided so you can retrieve historical data when necessary.

For example, this service can update Address Object on a Windows Computer. Using the Data Download Service, you would be able to download the data files specific for Address Object plus the correct Windows object library and any wrappers required, without needing to download the entire zip file.

Overview

The Data Download web service is quite simple with these main steps:

Choose your action.
Enter the required options and parameters.
Use the resulting URL to send your request.

A Data Download call is constructed from a base URL and action with select options and parameters (including your license key). Each of these will vary depending on the action type you choose.

These are only the basics! For more details, keep on reading.

Authentication

Melissa requires a License Key to use Data Download. Your License Key will be sent to you from your Melissa representative. Data Download itself doesn't have a license key, but requires a license key for the Melissa product you wish to download data for. Your license must also be current.

URL

This is the main URL for the Data Download web service. Each action is based off of this URL.

Use	URL
Secure	`https://releases.melissadata.net`

You combine the base URL with the action path you want to do to get your endpoint:

Action [Path]	URL + Action Path = Endpoint
Download File [/Download/Data]	https://releases.melissadata.net/Download/Data
File Hash [/md5/Data]	https://releases.melissadata.net/md5/Data
File Releases [/Releases/Data]	https://releases.melissadata.net/Releases/Data
Manifest [/Manifest]	https://releases.melissadata.net/Manifest
Manifest Releases [/ManifestReleases]	https://releases.melissadata.net/ManifestReleases
Manifest List [/ManifestList]	https://releases.melissadata.net/ManifestList

Use Case

For this use case, we'll update Address Object on a computer using Windows OS.

To do this, we'll use the Data Download Service to download the data files specific for Address Object and Windows. This includes the correct Windows object library and any required wrappers. We can do all of this without needing to download the entire release zip file!

Download Address Object Release

Let’s go through a step by step example of using Data Download to download the files for Address Object:

First we need to find the latest release manifests for our license. We'll use the Manifest List action to do this:

https://releases.melissadata.net/ManifestList/latest/?ID=[Address Object License]&FORMAT=xml

If you want to see the manifest for a specific Address Object release, specify the release in place of latest in the above request. As always, explore this documentation for a detailed explanation of Manifest List.

Then we choose our target manifest and navigate there to list the files.

https://releases.melissadata.net/Manifest/2021.03/dq_addr_data/?ID=[Address Object License]
https://releases.melissadata.net/Manifest/2021.03/dq_addr_bins/?ID=[Address Object License]

Now we can download the list of files for Address Object. Let’s pick mdAddr.dat and mdAddr.dll.

https://releases.melissadata.net/Download/Data/2021.03/mdAddr.dat/?ID=[Address Object License]
https://releases.melissadata.net/Download/Library/WINDOWS/DLL/64BIT/2021.03/mdAddr.dll/?ID=[Address Object License]

Finally, download the hash to do an md5 compare.

https://releases.melissadata.net/md5/Data/2021.03/mdAddr.dat/?ID=[Address Object License]

Note: For binaries and interface files, you'll need to specify the OS, compiler, language and architecture details:

https://releases.melissadata.net/md5/Library/WINDOWS/DLL/64BIT/2021.03/mdAddr.dll/?ID=[Address Object License]

For more information on the service and the endpoints, continue reading this most excellent document.

Actions

The Data Download web service has the following actions:

Action	Description
Download File	Returns a URL to download a file.
File Hash	Returns the hash for a file.
File Releases	Returns a release list for a file.
Manifest	Return a list of files associated with a manifest.
Manifest Releases	List a manifest's available releases.
Manifest List	Return a list of all manifests for a release.

!> Action Service URLs

//Download File
https://releases.melissadata.net/Download/[Action Type]

//File Hash
https://releases.melissadata.net/[hash]/[Action Type]

//File Release
https://releases.melissadata.net/Releases/[Action Type]

//Manifest Releases
https://releases.melissadata.net/ManifestReleases

//Manifest
https://releases.melissadata.net/Manifest

//Manifest List
https://releases.melissadata.net/ManifestList

Download File

Download File returns a URL to download the specified file. This has multiple action types and can return URLs for a Data File, Object Binary or Language Interface. Each action type requires different options and parameters, so pay close attention to the action type you're using.

`Data File Download URL`

Returns a URL to download the specified data file.

https://data.melissadata.com/Download/Data/[release]/[fileName]/?ID=[license]

Required Options
`release`
Required Parameters
`fileName`
`license`

`Object Binary Download URL`

Returns a URL to download the specified object binary.

https://data.melissadata.com/Download/Library/[os]/[compiler]/[architecture]/[release]/[fileName]/?ID=[license]

Required Options
`os`
`compiler`
`architecture`
`release`
Required Parameters
`fileName`
`license`

`Language Interface Download URL`

Returns a URL to download the specified language interface.

https://data.melissadata.com/Download/Interface/[os]/[language]/[architecture]/[release]/[fileName]/?ID=[license]

Required Options
`os`
`language`
`architecture`
`release`
Required Parameters
`fileName`
`license`

Download File Options

architecture - The architecture type. (See Architecture Options)
compiler - The compiler name. (See Compiler Name Options)
language - The language. (See Language Options)
release - The name of the release. (See Release Identification Options)
os - The Operating System (OS) name. (See OS Options)

Download File Parameters

fileName - The name of the file to download. This is not case sensitive.
license - The encrypted user license.

_ Example URLs

//Download File - Data File
https://data.melissadata.com/Download/Data/[release]/[fileName]/?ID=[license]

//Download File - Object Binary
https://data.melissadata.com/Download/Library/[os]/[compiler]/[architecture]/[release]/[fileName]/?ID=[license]

//Download File - Language Interface
https://data.melissadata.com/Download/Interface/[os]/[language]/[architecture]/[release]/[fileName]/?ID=[license]

File Hash

File Hash returns the file has for the selected file. This has multiple action types returning the file hash for a Data File, Object Binary or Language Interface. Each action type still requires different options and parameters, so stay vigilant.

`Data File Hash`

Returns a file hash for the specified data file.

https://data.melissadata.com/[hash]/Data/[release]/[fileName]/?ID=[license]

Required Options
`release`
Required Parameters
`hash`
`fileName`
`license`

`Object Binary File Hash`

Returns a file hash for the specified object binary.

https://data.melissadata.com/[hash]/Library/[os]/[compiler]/[architecture]/[release]/[fileName]/?ID=[license]

Required Options
`os`
`compiler`
`architecture`
`release`
Required Parameters
`hash`
`fileName`
`license`

`Language Interface File Hash`

Returns a URL to download the specified language interface.

https://data.melissadata.com/[hash]/Interface/[os]/[language]/[architecture]/[release]/[fileName]/?ID=[license]

Required Options
`os`
`language`
`architecture`
`release`
Required Parameters
`hash`
`fileName`
`license`

File Hash Options

architecture - The architecture type. (See Architecture Options)
compiler - The compiler name. (See Compiler Name Options)
language - The language. (See Language Options)
release - The name of the release. (See Release Identification Options)
os - The Operating System (OS) name. (See OS Options)

File Hash Parameters

hash - The file hash type: md5, sha1, or sha256.
fileName - The name of the file to download. This is not case sensitive.
license - The encrypted user license.

_ Example URLs

//File Hash - Data File
https://data.melissadata.com/[hash]/Data/[release]/[fileName]/?ID=[license]

//File Hash - Object Binary
https://data.melissadata.com/[hash]/Library/[os]/[compiler]/[architecture]/[release]/[fileName]/?ID=[license]

//File Hash - Language Interface
https://data.melissadata.com/[hash]/Interface/[os]/[language]/[architecture]/[release]/[fileName]/?ID=[license]

File Releases

File Releases returns a release list for the specified file. This still has multiple action types and can return URLs for a Data File, Object Binary or Language Interface. Each action type requires different options and parameters, so stay on target.

`Data File Releases`

Returns a list of file releases for the specified data file.

https://data.melissadata.com/Releases/Data/[fileName]/?ID=[license]&FORMAT=[format]

Required Options
`format`
Required Parameters
`fileName`
`license`

`Object Binary File Releases`

Returns a list of file releases for the specified object binary.

https://data.melissadata.com/Releases/Library/[os]/[compiler]/[architecture]/[fileName]/?ID=[license]&FORMAT=[format]

Required Options
`os`
`compiler`
`architecture`
`format`
Required Parameters
`fileName`
`license`

`Language Interface File Releases`

Returns a list of file releases for the specified language interface.

https://data.melissadata.com/Releases/Interface/[os]/[language]/[architecture]/[fileName]/?ID=[license]&FORMAT=[format]

Required Options
`os`
`language`
`architecture`
`format`
Required Parameters
`fileName`
`license`

File Releases Options

architecture - The architecture type. (See Architecture Options)
compiler - The compiler name. (See Compiler Name Options)
language - The language. (See Language Options)
os - The Operating System (OS) name. (See OS Options)
format - The desired format of the response. (See File Releases Formats)

File Releases Parameters

fileName - The name of the file to download. This is not case sensitive.
license - The encrypted user license.

_ Example URLs

//File Releases - Data File
https://data.melissadata.com/Releases/Data/[fileName]/?ID=[license]&FORMAT=[format]

//File Releases - Object Binary
https://data.melissadata.com/Releases/Library/[os]/[compiler]/[architecture]/[fileName]/?ID=[license]&FORMAT=[format]

//File Releases - Language Interface
https://data.melissadata.com/Releases/Interface/[os]/[language]/[architecture]/[fileName]/?ID=[license]&FORMAT=[format]

!> File Releases Formats

Format	Description
`crLfList`	(Default) File list delimited by CR/LF
`lfList`	File list delimited by LF
`comma`	Comma delimited list
`tab`	Tab delmited list
`json`	JSON serialized list
`xml`	XML serialized list

Manifest

`Manifest`

Manifest returns a list of files associated with the specified manifest.

https://data.melissadata.com/Manifest/[release]/[manifest]/?ID=[license]&FORMAT=[format]

Required Options
`release`
`format`
Required Parameters
`manifest`
`license`

`Manifest Releases`

Manifest Releases returns a release list for the specified manifest.

https://data.melissadata.com/ManifestReleases/[manifest]/?ID=[license]&FORMAT=[format]

Required Options
`format`
Required Parameters
`manifest`
`license`

`Manifest List`

Manifest List returns a list of all manifests for a particular release. Do not confuse the Manifest formats with the Manifest List formats. Manifest List only supports json or xml.

https://data.melissadata.com/ManifestList/[release]/?ID=[license]&FORMAT=[format]

Required Options
`release`
`format`
Required Parameters
`license`

Manifest Options

release - The name of the release. (See Release Identification Options)
format - The desired format of the response. (See Manifest Formats)

Manifest Parameters

manifest - The manifest name.
license - The encrypted user license.

_ Example URL

//Manifest
https://releases.melissadata.net/Manifest/[release]/[manifest]/?ID=[license]&FORMAT=[format]

//Manifest Releases
https://data.melissadata.com/ManifestReleases/[manifest]/?ID=[license]&FORMAT=[format]

//Manifest List
https://data.melissadata.com/ManifestList/[release]/?ID=[license]&FORMAT=[format]

!> Manifest Formats

Format	Description
`crLfList`	(Default) File list delimited by CR/LF
`lfList`	File list delimited by LF
`comma`	comma delimited list
`tab`	Tab delmited list
`json`	JSON serialized list
`xml`	XML serialized list

!> Manifest List Formats

Format	Description
`json`	JSON serialized list
`xml`	XML serialized list

Options

Architecture Options

Describes the target architecture (ie, ‘bitness’). Used for object binaries and language interface binaries on certain OS platforms:

Format	Description
`32BIT`	32-Bit Architecture
`64BIT`	64-Bit Architecture
`ANY`	Any Architecture

Compiler Name Options

Describes the target compiler:

Format	Description
`ACC3`	HP-UX native compiler
`COM`	Windows COM DLL
`DLL`	Windows standard DLL
`GCC32`	gcc v3.2 (Linux)
`GCC34`	gcc v3.4 (AIX, HP-UX, Linux)
`GCC41`	gcc v4.1 (Linux)
`WS6`	Solaris native compiler
`WS12`	Solaris native compiler
`XLC6`	AIX native compiler
`SSIS2005`	SSIS 2005 component
`SSIS2008`	SSIS 2008 component
`SSIS2012`	SSIS 2012 component
`SSIS2014`	SSIS 2014 component
`SSIS2016`	SSIS 2016 component
`SSIS2017`	SSIS 2017 component
`ANY`	Any

Language Options

Describes the language interface:

Format	Description
`NET`	.NET
`C`	C/C++
`JAVA`	Java
`PERL`	Perl
`PHP`	PHP (legacy, prior to v7)
`PHP7`	PHP v7
`PYTHON`	Python
`RUBY`	Ruby
`PLSQL`	Oracle PL/SQL
`MSSQL`	SQL Server T-SQL

OS Options

Describes the target OS. Used for object binaries and language interface binaries:

Format	Description
`AIX`	AIX PowerPC
`HPUX_IT`	HP-UX ia64
`HPUX_PA`	HP-UX RISC
`LINUX`	Linux Redhat
`SOLARIS`	Solaris Sparc
`WINDOWS`	Windows
`ANY`	Any

Release Identification Options

Releases can be specified in several ways:

Format	Description
`yyyy.mm` or `yyyy-mm`	For example, `2020-01`, `2020.01` or `2020.1` (will be corrected to `2020.01`)
`yyyy.Qq`	For example, `2020-Q1` and `2020.Q1`. The quarter will be translated into the first month of the specified quarter (ie, January, April, July or October).
`maj.min.sub.bld`	For example, `4.0.1.17362`.
`metaReleaseName`	For example, `latest`.